2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.dom.codec.impl;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
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;
27 import java.util.Map.Entry;
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;
36 // FIXME: 'SchemaUnawareCodec' is not correct: we use BitsTypeDefinition in construction
37 // FIXME: require the base class to be a TypeObject
38 // FIXME: MDSAL-743: require BitsTypeObject base class
39 final class BitsCodec extends SchemaUnawareCodec {
41 * Use identity comparison for keys and allow classes to be GCd themselves.
43 * Since codecs can (and typically do) hold a direct or indirect strong reference to the class, they need to be also
44 * accessed via reference. Using a weak reference could be problematic, because the codec would quite often be only
45 * weakly reachable. We therefore use a soft reference, whose implementation guidance is suitable to our use case:
47 * "Virtual machine implementations are, however, encouraged to bias against clearing recently-created or
48 * recently-used soft references."
50 private static final Cache<Class<?>, @NonNull BitsCodec> CACHE = CacheBuilder.newBuilder().weakKeys().softValues()
52 private static final MethodType CONSTRUCTOR_INVOKE_TYPE = MethodType.methodType(Object.class, Boolean[].class);
54 // Ordered by position
55 private final ImmutableMap<String, Method> getters;
56 // Ordered by lexical name
57 private final ImmutableSet<String> ctorArgs;
58 private final MethodHandle ctor;
60 private BitsCodec(final MethodHandle ctor, final Set<String> ctorArgs, final Map<String, Method> getters) {
61 this.ctor = requireNonNull(ctor);
62 this.ctorArgs = ImmutableSet.copyOf(ctorArgs);
63 this.getters = ImmutableMap.copyOf(getters);
66 static @NonNull BitsCodec of(final Class<?> returnType, final BitsTypeDefinition rootType)
67 throws ExecutionException {
68 return CACHE.get(returnType, () -> {
69 final Map<String, Method> getters = new LinkedHashMap<>();
70 final Set<String> ctorArgs = new TreeSet<>();
72 for (Bit bit : rootType.getBits()) {
73 final Method valueGetter = returnType.getMethod(BindingMapping.GETTER_PREFIX
74 + BindingMapping.getClassName(bit.getName()));
75 ctorArgs.add(bit.getName());
76 getters.put(bit.getName(), valueGetter);
78 Constructor<?> constructor = null;
79 for (Constructor<?> cst : returnType.getConstructors()) {
80 if (!cst.getParameterTypes()[0].equals(returnType)) {
85 final MethodHandle ctor = MethodHandles.publicLookup().unreflectConstructor(constructor)
86 .asSpreader(Boolean[].class, ctorArgs.size()).asType(CONSTRUCTOR_INVOKE_TYPE);
87 return new BitsCodec(ctor, ctorArgs, getters);
92 @SuppressWarnings("checkstyle:illegalCatch")
93 protected Object deserializeImpl(final Object input) {
94 checkArgument(input instanceof Set);
95 @SuppressWarnings("unchecked")
96 final Set<String> casted = (Set<String>) input;
99 * We can do this walk based on field set sorted by name, since constructor arguments in Java Binding are
102 * This means we will construct correct array for construction of bits object.
104 final Boolean[] args = new Boolean[ctorArgs.size()];
106 for (String value : ctorArgs) {
107 args[currentArg++] = casted.contains(value);
111 return ctor.invokeExact(args);
112 } catch (Throwable e) {
113 throw new IllegalStateException("Failed to instantiate object for " + input, e);
118 protected Set<String> serializeImpl(final Object input) {
119 final Collection<String> result = new ArrayList<>(getters.size());
120 for (Entry<String, Method> valueGet : getters.entrySet()) {
123 value = (Boolean) valueGet.getValue().invoke(input);
124 } catch (IllegalAccessException | InvocationTargetException e) {
125 throw new IllegalArgumentException("Failed to get bit " + valueGet.getKey(), e);
129 result.add(valueGet.getKey());
132 return result.size() == getters.size() ? getters.keySet() : ImmutableSet.copyOf(result);