Remove unneeded doc dependency
[mdsal.git] / binding / mdsal-binding-dom-codec / src / main / java / org / opendaylight / mdsal / binding / dom / codec / impl / DataContainerCodecContext.java
index df9ecabf6064a25a506802147a13ac667376d7bf..dc0566be9e580609dc2cf15dd7ec1e8ee1b3ad7d 100644 (file)
@@ -7,39 +7,68 @@
  */
 package org.opendaylight.mdsal.binding.dom.codec.impl;
 
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.collect.ImmutableCollection;
 import com.google.common.collect.ImmutableSet;
 import java.io.IOException;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.VarHandle;
 import java.util.List;
 import java.util.Optional;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import java.util.Set;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
-import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
+import org.opendaylight.mdsal.binding.dom.codec.api.IncorrectNestingException;
+import org.opendaylight.mdsal.binding.dom.codec.api.MissingClassInLoadingStrategyException;
+import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
+import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaForClassException;
+import org.opendaylight.mdsal.binding.model.api.Type;
+import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
+import org.opendaylight.mdsal.binding.runtime.api.CompositeRuntimeType;
+import org.opendaylight.mdsal.binding.runtime.api.RuntimeTypeContainer;
+import org.opendaylight.yangtools.yang.binding.Augmentation;
+import org.opendaylight.yangtools.yang.binding.BindingObject;
 import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
-import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
 
-abstract class DataContainerCodecContext<D extends DataObject, T extends WithStatus> extends NodeCodecContext<D>  {
+abstract class DataContainerCodecContext<D extends DataObject, T extends RuntimeTypeContainer> extends NodeCodecContext
+        implements BindingDataObjectCodecTreeNode<D>  {
+    private static final VarHandle EVENT_STREAM_SERIALIZER;
+
+    static {
+        try {
+            EVENT_STREAM_SERIALIZER = MethodHandles.lookup().findVarHandle(DataContainerCodecContext.class,
+                "eventStreamSerializer", DataObjectSerializer.class);
+        } catch (NoSuchFieldException | IllegalAccessException e) {
+            throw new ExceptionInInitializerError(e);
+        }
+    }
+
+    private final @NonNull DataContainerCodecPrototype<T> prototype;
 
-    private final DataContainerCodecPrototype<T> prototype;
+    // Accessed via a VarHandle
+    @SuppressWarnings("unused")
     private volatile DataObjectSerializer eventStreamSerializer;
 
-    protected DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
-        this.prototype = prototype;
+    DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
+        this.prototype = requireNonNull(prototype);
     }
 
-    @Override
-    public final T getSchema() {
-        return prototype.getSchema();
+    public final @NonNull T getType() {
+        return prototype.getType();
     }
 
     @Override
@@ -68,7 +97,7 @@ abstract class DataContainerCodecContext<D extends DataObject, T extends WithSta
      * @throws IllegalArgumentException If supplied argument does not represent valid child.
      */
     @Override
-    public abstract NodeCodecContext<?> yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg);
+    public abstract NodeCodecContext yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg);
 
     /**
      * Returns nested node context using supplied Binding Instance Identifier
@@ -79,17 +108,13 @@ abstract class DataContainerCodecContext<D extends DataObject, T extends WithSta
      * @throws IllegalArgumentException If supplied argument does not represent valid child.
      */
     @Override
-    @Nullable
-    public DataContainerCodecContext<?,?> bindingPathArgumentChild(final PathArgument arg,
+    public DataContainerCodecContext<?, ?> bindingPathArgumentChild(final PathArgument arg,
             final List<YangInstanceIdentifier.PathArgument> builder) {
         final DataContainerCodecContext<?,?> child = streamChild(arg.getType());
-        if (child != null) {
-            if (builder != null) {
-                child.addYangPathArgument(arg,builder);
-            }
-            return child;
+        if (builder != null) {
+            child.addYangPathArgument(arg,builder);
         }
-        throw new IllegalArgumentException("Supplied argument is not valid child");
+        return child;
     }
 
     /**
@@ -109,16 +134,8 @@ abstract class DataContainerCodecContext<D extends DataObject, T extends WithSta
         return Class.class.cast(prototype.getBindingClass());
     }
 
-    /**
-     * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
-     * must issue getChild(ChoiceClass).getChild(CaseClass).
-     *
-     * @param childClass child class
-     * @return Context of child node or null, if supplied class is not subtree child
-     * @throws IllegalArgumentException If supplied child class is not valid in specified context.
-     */
     @Override
-    public abstract @Nullable <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(Class<C> childClass);
+    public abstract <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(Class<C> childClass);
 
     /**
      * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
@@ -138,57 +155,95 @@ abstract class DataContainerCodecContext<D extends DataObject, T extends WithSta
 
     @Override
     public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
-            final ImmutableCollection<Class<? extends DataObject>> cacheSpecifier) {
+            final ImmutableCollection<Class<? extends BindingObject>> cacheSpecifier) {
         if (cacheSpecifier.isEmpty()) {
             return new NonCachingCodec<>(this);
         }
-        return new CachingNormalizedNodeCodec<>(this,ImmutableSet.copyOf(cacheSpecifier));
+        return new CachingNormalizedNodeCodec<>(this, ImmutableSet.copyOf(cacheSpecifier));
     }
 
-    BindingStreamEventWriter createWriter(final NormalizedNodeStreamWriter domWriter) {
+    @NonNull BindingStreamEventWriter createWriter(final NormalizedNodeStreamWriter domWriter) {
         return BindingToNormalizedStreamWriter.create(this, domWriter);
     }
 
-    @Nonnull
-    protected final <V> V childNonNull(@Nullable final V nullable, final YangInstanceIdentifier.PathArgument child,
-            final String message, final Object... args) {
-        if (nullable != null) {
-            return nullable;
+    protected final <V> @NonNull V childNonNull(final @Nullable V nullable,
+            final YangInstanceIdentifier.PathArgument child, final String message, final Object... args) {
+        if (nullable == null) {
+            throw childNullException(extractName(child), message, args);
         }
-        MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
-        throw IncorrectNestingException.create(message, args);
+        return nullable;
     }
 
-    @Nonnull
-    protected final <V> V childNonNull(@Nullable final V nullable, final QName child, final String message,
+    protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final QName child, final String message,
             final Object... args) {
-        if (nullable != null) {
-            return nullable;
+        if (nullable == null) {
+            throw childNullException(child, message, args);
+        }
+        return nullable;
+    }
+
+    protected final <V> @NonNull V childNonNull(final @Nullable V nullable, final Class<?> childClass,
+            final String message, final Object... args) {
+        if (nullable == null) {
+            throw childNullException(childClass, message, args);
+        }
+        return nullable;
+    }
+
+    private IllegalArgumentException childNullException(final QName child, final String message, final Object... args) {
+        final QNameModule module = child.getModule();
+        if (!factory().getRuntimeContext().getEffectiveModelContext().findModule(module).isPresent()) {
+            throw new MissingSchemaException("Module " + module + " is not present in current schema context.");
         }
-        MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
         throw IncorrectNestingException.create(message, args);
     }
 
-    @Nonnull
-    protected final <V> V childNonNull(@Nullable final V nullable, final Class<?> childClass, final String message,
+    private IllegalArgumentException childNullException(final Class<?> childClass, final String message,
             final Object... args) {
-        if (nullable != null) {
-            return nullable;
+        final BindingRuntimeContext runtimeContext = factory().getRuntimeContext();
+        final CompositeRuntimeType schema;
+        if (Augmentation.class.isAssignableFrom(childClass)) {
+            schema = runtimeContext.getAugmentationDefinition(childClass.asSubclass(Augmentation.class));
+        } else {
+            schema = runtimeContext.getSchemaDefinition(childClass);
+        }
+        if (schema == null) {
+            throw new MissingSchemaForClassException(childClass);
+        }
+
+        try {
+            runtimeContext.loadClass(Type.of(childClass));
+        } catch (final ClassNotFoundException e) {
+            throw new MissingClassInLoadingStrategyException(
+                "User supplied class " + childClass.getName() + " is not available in " + runtimeContext, e);
         }
-        MissingSchemaForClassException.check(factory().getRuntimeContext(), childClass);
-        MissingClassInLoadingStrategyException.check(factory().getRuntimeContext().getStrategy(), childClass);
+
         throw IncorrectNestingException.create(message, args);
     }
 
-    DataObjectSerializer eventStreamSerializer() {
-        if (eventStreamSerializer == null) {
-            eventStreamSerializer = factory().getEventStreamSerializer(getBindingClass());
+    private static QName extractName(final YangInstanceIdentifier.PathArgument child) {
+        if (child instanceof AugmentationIdentifier) {
+            final Set<QName> children = ((AugmentationIdentifier) child).getPossibleChildNames();
+            checkArgument(!children.isEmpty(), "Augmentation without childs must not be used in data");
+            return children.iterator().next();
         }
-        return eventStreamSerializer;
+        return child.getNodeType();
+    }
+
+    final DataObjectSerializer eventStreamSerializer() {
+        final DataObjectSerializer existing = (DataObjectSerializer) EVENT_STREAM_SERIALIZER.getAcquire(this);
+        return existing != null ? existing : loadEventStreamSerializer();
+    }
+
+    // Split out to aid inlining
+    private DataObjectSerializer loadEventStreamSerializer() {
+        final DataObjectSerializer loaded = factory().getEventStreamSerializer(getBindingClass());
+        final Object witness = EVENT_STREAM_SERIALIZER.compareAndExchangeRelease(this, null, loaded);
+        return witness == null ? loaded : (DataObjectSerializer) witness;
     }
 
     @Override
-    public NormalizedNode<?, ?> serialize(final D data) {
+    public NormalizedNode serialize(final D data) {
         final NormalizedNodeResult result = new NormalizedNodeResult();
         // We create DOM stream writer which produces normalized nodes
         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
@@ -204,5 +259,4 @@ abstract class DataContainerCodecContext<D extends DataObject, T extends WithSta
             throw new IllegalStateException("Failed to serialize Binding DTO",e);
         }
     }
-
 }