binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BitsCodec.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.cache.Cache;
  14 import com.google.common.cache.CacheBuilder;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.collect.ImmutableSet;
  17 import java.lang.invoke.MethodHandle;
  18 import java.lang.invoke.MethodHandles;
  19 import java.lang.invoke.MethodType;
  20 import java.lang.reflect.Constructor;
  21 import java.lang.reflect.InvocationTargetException;
  22 import java.lang.reflect.Method;
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.LinkedHashMap;
  26 import java.util.Map;
  27 import java.util.Map.Entry;
  28 import java.util.Set;
  29 import java.util.TreeSet;
  30 import java.util.concurrent.ExecutionException;
  31 import org.eclipse.jdt.annotation.NonNull;
  32 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  33 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
  35
  36 final class BitsCodec extends ReflectionBasedCodec implements SchemaUnawareCodec {
  37     /*
  38      * Use identity comparison for keys and allow classes to be GCd themselves.
  39      *
  40      * Since codecs can (and typically do) hold a direct or indirect strong reference to the class, they need to be also
  41      * accessed via reference. Using a weak reference could be problematic, because the codec would quite often be only
  42      * weakly reachable. We therefore use a soft reference, whose implementation guidance is suitable to our use case:
  43      *
  44      *     "Virtual machine implementations are, however, encouraged to bias against clearing recently-created or
  45      *      recently-used soft references."
  46      */
  47     private static final Cache<Class<?>, @NonNull BitsCodec> CACHE = CacheBuilder.newBuilder().weakKeys().softValues()
  48         .build();
  49     private static final MethodType CONSTRUCTOR_INVOKE_TYPE = MethodType.methodType(Object.class, Boolean[].class);
  50
  51     // Ordered by position
  52     private final ImmutableMap<String, Method> getters;
  53     // Ordered by lexical name
  54     private final ImmutableSet<String> ctorArgs;
  55     private final MethodHandle ctor;
  56
  57     private BitsCodec(final Class<?> typeClass, final MethodHandle ctor, final Set<String> ctorArgs,
  58             final Map<String, Method> getters) {
  59         super(typeClass);
  60         this.ctor = requireNonNull(ctor);
  61         this.ctorArgs = ImmutableSet.copyOf(ctorArgs);
  62         this.getters = ImmutableMap.copyOf(getters);
  63     }
  64
  65     static @NonNull BitsCodec of(final Class<?> returnType, final BitsTypeDefinition rootType)
  66             throws ExecutionException {
  67         return CACHE.get(returnType, () -> {
  68             final Map<String, Method> getters = new LinkedHashMap<>();
  69             final Set<String> ctorArgs = new TreeSet<>();
  70
  71             for (Bit bit : rootType.getBits()) {
  72                 final Method valueGetter = returnType.getMethod(BindingMapping.GETTER_PREFIX
  73                     + BindingMapping.getClassName(bit.getName()));
  74                 ctorArgs.add(bit.getName());
  75                 getters.put(bit.getName(), valueGetter);
  76             }
  77             Constructor<?> constructor = null;
  78             for (Constructor<?> cst : returnType.getConstructors()) {
  79                 if (!cst.getParameterTypes()[0].equals(returnType)) {
  80                     constructor = cst;
  81                 }
  82             }
  83
  84             final MethodHandle ctor = MethodHandles.publicLookup().unreflectConstructor(constructor)
  85                     .asSpreader(Boolean[].class, ctorArgs.size()).asType(CONSTRUCTOR_INVOKE_TYPE);
  86             return new BitsCodec(returnType, ctor, ctorArgs, getters);
  87         });
  88     }
  89
  90     @Override
  91     @SuppressWarnings("checkstyle:illegalCatch")
  92     public Object deserialize(final Object input) {
  93         checkArgument(input instanceof Set);
  94         @SuppressWarnings("unchecked")
  95         final Set<String> casted = (Set<String>) input;
  96
  97         /*
  98          * We can do this walk based on field set sorted by name, since constructor arguments in Java Binding are
  99          * sorted by name.
 100          *
 101          * This means we will construct correct array for construction of bits object.
 102          */
 103         final Boolean[] args = new Boolean[ctorArgs.size()];
 104         int currentArg = 0;
 105         for (String value : ctorArgs) {
 106             args[currentArg++] = casted.contains(value);
 107         }
 108
 109         try {
 110             return ctor.invokeExact(args);
 111         } catch (Throwable e) {
 112             throw new IllegalStateException("Failed to instantiate object for " + input, e);
 113         }
 114     }
 115
 116     @Override
 117     public Set<String> serialize(final Object input) {
 118         final Collection<String> result = new ArrayList<>(getters.size());
 119         for (Entry<String, Method> valueGet : getters.entrySet()) {
 120             final Boolean value;
 121             try {
 122                 value = (Boolean) valueGet.getValue().invoke(input);
 123             } catch (IllegalAccessException | InvocationTargetException e) {
 124                 throw new IllegalArgumentException("Failed to get bit " + valueGet.getKey(), e);
 125             }
 126
 127             if (value) {
 128                 result.add(valueGet.getKey());
 129             }
 130         }
 131         return result.size() == getters.size() ? getters.keySet() : ImmutableSet.copyOf(result);
 132     }
 133 }