Remove use of deprecated createCursor() method
[mdsal.git] / binding / mdsal-binding-dom-codec / src / main / java / org / opendaylight / mdsal / binding / dom / codec / impl / LazyDataObject.java
index 998f461583ddf223509b2d061aadeed5d57d2ede..5c7382c1c037c9c4086876a9b94bd89559d69c3f 100644 (file)
@@ -7,10 +7,14 @@
  */
 package org.opendaylight.mdsal.binding.dom.codec.impl;
 
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME;
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME;
+
 import com.google.common.base.MoreObjects;
 import com.google.common.base.MoreObjects.ToStringHelper;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.InvocationTargetException;
@@ -19,12 +23,15 @@ import java.lang.reflect.Proxy;
 import java.util.Arrays;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.mdsal.binding.dom.codec.util.AugmentationReader;
+import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
 import org.opendaylight.yangtools.yang.binding.Augmentable;
 import org.opendaylight.yangtools.yang.binding.Augmentation;
 import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
@@ -34,46 +41,61 @@ import org.slf4j.LoggerFactory;
 class LazyDataObject<D extends DataObject> implements InvocationHandler, AugmentationReader {
 
     private static final Logger LOG = LoggerFactory.getLogger(LazyDataObject.class);
-    private static final String GET_IMPLEMENTED_INTERFACE = "getImplementedInterface";
     private static final String TO_STRING = "toString";
     private static final String EQUALS = "equals";
-    private static final String GET_AUGMENTATION = "getAugmentation";
     private static final String HASHCODE = "hashCode";
     private static final String AUGMENTATIONS = "augmentations";
-    private static final Object NULL_VALUE = new Object();
+    private static final @NonNull Object NULL_VALUE = new Object();
 
-    private final ConcurrentHashMap<Method, Object> cachedData = new ConcurrentHashMap<>();
+    // Method.getName() is guaranteed to be interned and all getter methods have zero arguments, name is sufficient to
+    // identify the data, skipping Method.hashCode() computation.
+    private final ConcurrentHashMap<String, Object> cachedData = new ConcurrentHashMap<>();
     private final NormalizedNodeContainer<?, PathArgument, NormalizedNode<?, ?>> data;
     private final DataObjectCodecContext<D,?> context;
 
+    @SuppressWarnings("rawtypes")
+    private static final AtomicReferenceFieldUpdater<LazyDataObject, ImmutableMap> CACHED_AUGMENTATIONS_UPDATER =
+            AtomicReferenceFieldUpdater.newUpdater(LazyDataObject.class, ImmutableMap.class, "cachedAugmentations");
     private volatile ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> cachedAugmentations = null;
     private volatile Integer cachedHashcode = null;
 
     @SuppressWarnings({ "rawtypes", "unchecked" })
     LazyDataObject(final DataObjectCodecContext<D,?> ctx, final NormalizedNodeContainer data) {
-        this.context = Preconditions.checkNotNull(ctx, "Context must not be null");
-        this.data = Preconditions.checkNotNull(data, "Data must not be null");
+        this.context = requireNonNull(ctx, "Context must not be null");
+        this.data = requireNonNull(data, "Data must not be null");
     }
 
     @Override
-    public Object invoke(final Object proxy, final Method method, final Object[] args) throws Throwable {
-        if (method.getParameterTypes().length == 0) {
-            final String name = method.getName();
-            if (GET_IMPLEMENTED_INTERFACE.equals(name)) {
-                return context.getBindingClass();
-            } else if (TO_STRING.equals(name)) {
-                return bindingToString();
-            } else if (HASHCODE.equals(name)) {
-                return bindingHashCode();
-            } else if (AUGMENTATIONS.equals(name)) {
-                return getAugmentationsImpl();
-            }
-            return getBindingData(method);
-        } else if (GET_AUGMENTATION.equals(method.getName())) {
-            return getAugmentationImpl((Class<?>) args[0]);
-        } else if (EQUALS.equals(method.getName())) {
-            return bindingEquals(args[0]);
+    public Object invoke(final Object proxy, final Method method, final Object[] args) {
+        switch (method.getParameterCount()) {
+            case 0:
+                final String methodName = method.getName();
+                switch (methodName) {
+                    case DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME:
+                        return context.getBindingClass();
+                    case TO_STRING:
+                        return bindingToString();
+                    case HASHCODE:
+                        return bindingHashCode();
+                    case AUGMENTATIONS:
+                        return getAugmentationsImpl();
+                    default:
+                        return method.isDefault() ? nonnullBindingData(methodName) : getBindingData(methodName);
+                }
+            case 1:
+                switch (method.getName()) {
+                    case AUGMENTABLE_AUGMENTATION_NAME:
+                        return getAugmentationImpl((Class<?>) args[0]);
+                    case EQUALS:
+                        return bindingEquals(args[0]);
+                    default:
+                        break;
+                }
+                break;
+            default:
+                break;
         }
+
         throw new UnsupportedOperationException("Unsupported method " + method);
     }
 
@@ -81,27 +103,28 @@ class LazyDataObject<D extends DataObject> implements InvocationHandler, Augment
         if (other == null) {
             return false;
         }
-        if (!context.getBindingClass().isAssignableFrom(other.getClass())) {
+        final Class<D> bindingClass = context.getBindingClass();
+        if (!bindingClass.isAssignableFrom(other.getClass())) {
             return false;
         }
         try {
-            for (final Method m : context.getHashCodeAndEqualsMethods()) {
-                final Object thisValue = getBindingData(m);
+            for (final Method m : context.propertyMethods()) {
+                final Object thisValue = getBindingData(m.getName());
                 final Object otherValue = m.invoke(other);
                 /*
-                *   added for valid byte array comparison, when list key type is binary
-                *   deepEquals is not used since it does excessive amount of instanceof calls.
-                */
+                 *   added for valid byte array comparison, when list key type is binary
+                 *   deepEquals is not used since it does excessive amount of instanceof calls.
+                 */
                 if (thisValue instanceof byte[] && otherValue instanceof byte[]) {
                     if (!Arrays.equals((byte[]) thisValue, (byte[]) otherValue)) {
                         return false;
                     }
-                } else if (!Objects.equals(thisValue, otherValue)){
+                } else if (!Objects.equals(thisValue, otherValue)) {
                     return false;
                 }
             }
 
-            if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
+            if (Augmentable.class.isAssignableFrom(bindingClass)) {
                 if (!getAugmentationsImpl().equals(getAllAugmentations(other))) {
                     return false;
                 }
@@ -116,7 +139,7 @@ class LazyDataObject<D extends DataObject> implements InvocationHandler, Augment
     private static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAllAugmentations(final Object dataObject) {
         if (dataObject instanceof AugmentationReader) {
             return ((AugmentationReader) dataObject).getAugmentations(dataObject);
-        } else if (dataObject instanceof Augmentable<?>){
+        } else if (dataObject instanceof Augmentable<?>) {
             return BindingReflections.getAugmentations((Augmentable<?>) dataObject);
         }
 
@@ -124,87 +147,101 @@ class LazyDataObject<D extends DataObject> implements InvocationHandler, Augment
     }
 
     private Integer bindingHashCode() {
-        final Integer ret = cachedHashcode;
-        if (ret != null) {
-            return ret;
+        final Integer cached = cachedHashcode;
+        if (cached != null) {
+            return cached;
         }
 
         final int prime = 31;
         int result = 1;
-        for (final Method m : context.getHashCodeAndEqualsMethods()) {
-            final Object value = getBindingData(m);
+        for (final Method m : context.propertyMethods()) {
+            final Object value = getBindingData(m.getName());
             result = prime * result + Objects.hashCode(value);
         }
         if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
             result = prime * result + getAugmentationsImpl().hashCode();
         }
-        cachedHashcode = result;
-        return result;
+        final Integer ret = result;
+        cachedHashcode = ret;
+        return ret;
     }
 
-    private Object getBindingData(final Method method) {
-        Object cached = cachedData.get(method);
-        if (cached == null) {
-            final Object readedValue = context.getBindingChildValue(method, data);
-            if (readedValue == null) {
-                cached = NULL_VALUE;
-            } else {
-                cached = readedValue;
-            }
-            cachedData.putIfAbsent(method, cached);
+    private Object nonnullBindingData(final String methodName) {
+        final Object value = getBindingData(context.getterNameForNonnullName(methodName));
+        return value != null ? value : ImmutableList.of();
+    }
+
+    // Internal invocation, can only target getFoo() methods
+    private Object getBindingData(final String methodName) {
+        final Object cached = cachedData.get(methodName);
+        if (cached != null) {
+            return unmaskNull(cached);
         }
 
-        return cached == NULL_VALUE ? null : cached;
+        final Object value = context.getBindingChildValue(methodName, data);
+        final Object raced = cachedData.putIfAbsent(methodName, value == null ? NULL_VALUE : value);
+        // If we raced we need to return previously-stored value
+        return raced != null ? unmaskNull(raced) : value;
+    }
+
+    private static Object unmaskNull(final @NonNull Object masked) {
+        return masked == NULL_VALUE ? null : masked;
     }
 
     private Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentationsImpl() {
-        ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> ret = cachedAugmentations;
-        if (ret == null) {
-            synchronized (this) {
-                ret = cachedAugmentations;
-                if (ret == null) {
-                    ret = ImmutableMap.copyOf(context.getAllAugmentationsFrom(data));
-                    cachedAugmentations = ret;
-                }
-            }
+        ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> local = cachedAugmentations;
+        if (local != null) {
+            return local;
         }
 
-        return ret;
+        local = ImmutableMap.copyOf(context.getAllAugmentationsFrom(data));
+        return CACHED_AUGMENTATIONS_UPDATER.compareAndSet(this, null, local) ? local : cachedAugmentations;
     }
 
     @Override
     public Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Object obj) {
-        Preconditions.checkArgument(this == Proxy.getInvocationHandler(obj),
+        checkArgument(this == Proxy.getInvocationHandler(obj),
                 "Supplied object is not associated with this proxy handler");
 
         return getAugmentationsImpl();
     }
 
     private Object getAugmentationImpl(final Class<?> cls) {
+        requireNonNull(cls, "Supplied augmentation must not be null.");
+
         final ImmutableMap<Class<? extends Augmentation<?>>, Augmentation<?>> aug = cachedAugmentations;
         if (aug != null) {
             return aug.get(cls);
         }
-        Preconditions.checkNotNull(cls,"Supplied augmentation must not be null.");
 
         @SuppressWarnings({"unchecked","rawtypes"})
-        final Optional<DataContainerCodecContext<?,?>> augCtx= context.possibleStreamChild((Class) cls);
-        if(augCtx.isPresent()) {
-            final Optional<NormalizedNode<?, ?>> augData = data.getChild(augCtx.get().getDomPathArgument());
-            if (augData.isPresent()) {
-                return augCtx.get().deserialize(augData.get());
+        final Optional<DataContainerCodecContext<?, ?>> optAugCtx = context.possibleStreamChild((Class) cls);
+        if (optAugCtx.isPresent()) {
+            final DataContainerCodecContext<?, ?> augCtx = optAugCtx.get();
+            // Due to binding specification not representing grouping instantiations we can end up having the same
+            // augmentation applied to a grouping multiple times. While these augmentations have the same shape, they
+            // are still represented by distinct binding classes and therefore we need to make sure the result matches
+            // the augmentation the user is requesting -- otherwise a strict receiver would end up with a cryptic
+            // ClassCastException.
+            if (cls.isAssignableFrom(augCtx.getBindingClass())) {
+                final Optional<NormalizedNode<?, ?>> augData = data.getChild(augCtx.getDomPathArgument());
+                if (augData.isPresent()) {
+                    return augCtx.deserialize(augData.get());
+                }
             }
         }
         return null;
     }
 
     public String bindingToString() {
-        final ToStringHelper helper = MoreObjects.toStringHelper(context.getBindingClass()).omitNullValues();
+        final Class<D> bindingClass = context.getBindingClass();
+        final ToStringHelper helper = MoreObjects.toStringHelper(bindingClass).omitNullValues();
 
-        for (final Method m :context.getHashCodeAndEqualsMethods()) {
-            helper.add(m.getName(), getBindingData(m));
+        for (final Method m : context.propertyMethods()) {
+            final String methodName = m.getName();
+            helper.add(methodName, getBindingData(methodName));
         }
-        if (Augmentable.class.isAssignableFrom(context.getBindingClass())) {
+        if (Augmentable.class.isAssignableFrom(bindingClass)) {
             helper.add("augmentations", getAugmentationsImpl());
         }
         return helper.toString();