Adopt odlparent-10.0.0/yangtools-8.0.0-SNAPSHOT
[mdsal.git] / binding / mdsal-binding-dom-codec / src / main / java / org / opendaylight / mdsal / binding / dom / codec / impl / LeafNodeCodecContext.java
index e681979d8b539e1c9a3cb7b65a1b8f81c9202804..573b476b12efcb58c0aedbaa9ab4b0e1be520a61 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2019 PANTHEON.tech, s.r.o. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -7,86 +7,98 @@
  */
 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 java.lang.reflect.Method;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
 import java.util.Optional;
-import java.util.Set;
-import org.eclipse.jdt.annotation.Nullable;
-import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
-import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
-import org.opendaylight.yangtools.concepts.Codec;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.binding.dom.codec.api.BindingTypeObjectCodecTreeNode;
+import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
+import org.opendaylight.yangtools.yang.binding.TypeObject;
 import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
-import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
-import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
 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.codec.TypeDefinitionAwareCodec;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
 
-final class LeafNodeCodecContext<D extends DataObject> extends NodeCodecContext<D> implements NodeContextSupplier {
+class LeafNodeCodecContext extends ValueNodeCodecContext.WithCodec {
+    static final class OfTypeObject<T extends TypeObject> extends LeafNodeCodecContext
+            implements BindingTypeObjectCodecTreeNode<T> {
+        private final @NonNull Class<T> bindingClass;
 
-    private final YangInstanceIdentifier.PathArgument yangIdentifier;
-    private final Codec<Object, Object> valueCodec;
-    private final Method getter;
-    private final DataSchemaNode schema;
-    private final Object defaultObject;
+        OfTypeObject(final LeafSchemaNode schema, final IllegalArgumentCodec<Object, Object> codec,
+                final String getterName, final EffectiveModelContext schemaContext, final Class<T> bindingClass) {
+            super(schema, codec, getterName, schemaContext);
+            this.bindingClass = requireNonNull(bindingClass);
+        }
+
+        @Override
+        public Class<T> getBindingClass() {
+            return bindingClass;
+        }
+
+        @Override
+        public T deserialize(final NormalizedNode data) {
+            return bindingClass.cast(deserializeObject(data));
+        }
 
-    LeafNodeCodecContext(final DataSchemaNode schema, final Codec<Object, Object> codec, final Method getter,
-                final SchemaContext schemaContext) {
-        this.yangIdentifier = new YangInstanceIdentifier.NodeIdentifier(schema.getQName());
-        this.valueCodec = requireNonNull(codec);
-        this.getter = getter;
-        this.schema = requireNonNull(schema);
+        @Override
+        public NormalizedNode serialize(final T data) {
+            return ImmutableNodes.leafNode(getDomPathArgument(), getValueCodec().serialize(data));
+        }
+    }
 
-        this.defaultObject = createDefaultObject(schema, valueCodec, schemaContext);
+    LeafNodeCodecContext(final LeafSchemaNode schema, final IllegalArgumentCodec<Object, Object> codec,
+            final String getterName, final EffectiveModelContext schemaContext) {
+        super(schema, codec, getterName, createDefaultObject(schema, codec, schemaContext));
     }
 
-    private static Object createDefaultObject(final DataSchemaNode schema, final Codec<Object, Object> codec,
-                                              final SchemaContext schemaContext) {
-        if (schema instanceof LeafSchemaNode) {
-            java.util.Optional<? extends Object> defaultValue = ((LeafSchemaNode) schema).getType().getDefaultValue();
-            TypeDefinition<?> type = ((LeafSchemaNode) schema).getType();
-            if (defaultValue.isPresent()) {
-                if (type instanceof IdentityrefTypeDefinition) {
-                    return qnameDomValueFromString(codec, schema, (String) defaultValue.get(), schemaContext);
-                }
-                return domValueFromString(codec, type, defaultValue.get());
-            }
+    static LeafNodeCodecContext of(final LeafSchemaNode schema, final IllegalArgumentCodec<Object, Object> codec,
+            final String getterName, final Class<?> valueType, final EffectiveModelContext schemaContext) {
+        return TypeObject.class.isAssignableFrom(valueType)
+                ? new OfTypeObject<>(schema, codec, getterName, schemaContext, valueType.asSubclass(TypeObject.class))
+                        : new LeafNodeCodecContext(schema, codec, getterName, schemaContext);
+    }
 
-            while (type.getBaseType() != null && !type.getDefaultValue().isPresent()) {
-                type = type.getBaseType();
+    @Override
+    protected Object deserializeObject(final NormalizedNode normalizedNode) {
+        return normalizedNode != null ? getValueCodec().deserialize(normalizedNode.body()) : null;
+    }
+
+    private static Object createDefaultObject(final LeafSchemaNode schema,
+                                              final IllegalArgumentCodec<Object, Object> codec,
+                                              final EffectiveModelContext schemaContext) {
+        Optional<? extends Object> defaultValue = schema.getType().getDefaultValue();
+        TypeDefinition<?> type = schema.getType();
+        if (defaultValue.isPresent()) {
+            if (type instanceof IdentityrefTypeDefinition) {
+                return qnameDomValueFromString(codec, schema, (String) defaultValue.get(), schemaContext);
             }
+            return domValueFromString(codec, type, defaultValue.get());
+        }
 
-            defaultValue = type.getDefaultValue();
-            if (defaultValue.isPresent()) {
-                if (type instanceof IdentityrefTypeDefinition) {
-                    return qnameDomValueFromString(codec, schema, (String) defaultValue.get(), schemaContext);
-                }
-                return domValueFromString(codec, type, defaultValue);
+        while (type.getBaseType() != null && !type.getDefaultValue().isPresent()) {
+            type = type.getBaseType();
+        }
+
+        defaultValue = type.getDefaultValue();
+        if (defaultValue.isPresent()) {
+            if (type instanceof IdentityrefTypeDefinition) {
+                return qnameDomValueFromString(codec, schema, (String) defaultValue.get(), schemaContext);
             }
+            return domValueFromString(codec, type, defaultValue);
         }
         return null;
     }
 
-    private static Object qnameDomValueFromString(final Codec<Object, Object> codec, final DataSchemaNode schema,
-                                                  final String defaultValue, final SchemaContext schemaContext) {
+    private static Object qnameDomValueFromString(final IllegalArgumentCodec<Object, Object> codec,
+                                                  final DataSchemaNode schema, final String defaultValue,
+                                                  final EffectiveModelContext schemaContext) {
         int prefixEndIndex = defaultValue.indexOf(':');
         QName qname;
         if (prefixEndIndex != -1) {
@@ -98,8 +110,7 @@ final class LeafNodeCodecContext<D extends DataObject> extends NodeCodecContext<
                 return codec.deserialize(qname);
             }
 
-            Set<ModuleImport> imports = module.getImports();
-            for (ModuleImport moduleImport : imports) {
+            for (ModuleImport moduleImport : module.getImports()) {
                 if (moduleImport.getPrefix().equals(defaultValuePrefix)) {
                     Module importedModule = schemaContext.findModule(moduleImport.getModuleName(),
                         moduleImport.getRevision()).get();
@@ -114,128 +125,15 @@ final class LeafNodeCodecContext<D extends DataObject> extends NodeCodecContext<
         return codec.deserialize(qname);
     }
 
-    private static Object domValueFromString(final Codec<Object, Object> codec, final TypeDefinition<?> type,
-            final Object defaultValue) {
+    private static Object domValueFromString(final IllegalArgumentCodec<Object, Object> codec,
+            final TypeDefinition<?> type, final Object defaultValue) {
         TypeDefinitionAwareCodec<?, ?> typeDefAwareCodec = TypeDefinitionAwareCodec.from(type);
         if (typeDefAwareCodec != null) {
             Object castedDefaultValue = typeDefAwareCodec.deserialize((String) defaultValue);
             return codec.deserialize(castedDefaultValue);
         }
-        // FIXME: BUG-4647 Refactor / redesign this to throw hard error,
-        // once BUG-4638 is fixed and will provide proper getDefaultValue implementation.
-        return null;
-    }
-
-    @Override
-    protected YangInstanceIdentifier.PathArgument getDomPathArgument() {
-        return yangIdentifier;
-    }
-
-    protected Codec<Object, Object> getValueCodec() {
-        return valueCodec;
-    }
-
-    @Override
-    public D deserialize(final NormalizedNode<?, ?> normalizedNode) {
-        throw new UnsupportedOperationException("Leaf can not be deserialized to DataObject");
-    }
-
-    @Override
-    public NodeCodecContext<?> get() {
-        return this;
-    }
-
-    Method getGetter() {
-        return getter;
-    }
-
-    @Override
-    public BindingCodecTreeNode<?> bindingPathArgumentChild(final PathArgument arg,
-            final List<YangInstanceIdentifier.PathArgument> builder) {
-        throw new IllegalArgumentException("Leaf does not have children");
-    }
-
-    @Override
-    public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
-            final ImmutableCollection<Class<? extends DataObject>> cacheSpecifier) {
-        throw new UnsupportedOperationException("Leaves does not support caching codec.");
-    }
-
-    @Override
-    public Class<D> getBindingClass() {
-        throw new UnsupportedOperationException("Leaf does not have DataObject representation");
-    }
-
-    @Override
-    public NormalizedNode<?, ?> serialize(final D data) {
-        throw new UnsupportedOperationException("Separete serialization of leaf node is not supported.");
-    }
-
-    @Override
-    public void writeAsNormalizedNode(final D data, final NormalizedNodeStreamWriter writer) {
-        throw new UnsupportedOperationException("Separete serialization of leaf node is not supported.");
-    }
-
-    @Override
-    public <E extends DataObject> BindingCodecTreeNode<E> streamChild(final Class<E> childClass) {
-        throw new IllegalArgumentException("Leaf does not have children");
-    }
-
-    @Override
-    public <E extends DataObject> Optional<? extends BindingCodecTreeNode<E>> possibleStreamChild(
-            final Class<E> childClass) {
-        throw new IllegalArgumentException("Leaf does not have children");
-    }
-
-    @Override
-    public BindingCodecTreeNode<?> yangPathArgumentChild(final YangInstanceIdentifier.PathArgument child) {
-        throw new IllegalArgumentException("Leaf does not have children");
-    }
-
-    @Override
-    protected Object deserializeObject(final NormalizedNode<?, ?> normalizedNode) {
-        if (normalizedNode instanceof LeafNode<?>) {
-            return valueCodec.deserialize(normalizedNode.getValue());
-        }
-        if (normalizedNode instanceof LeafSetNode<?>) {
-            @SuppressWarnings("unchecked")
-            final Collection<LeafSetEntryNode<Object>> domValues = ((LeafSetNode<Object>) normalizedNode).getValue();
-            final List<Object> result = new ArrayList<>(domValues.size());
-            for (final LeafSetEntryNode<Object> valueNode : domValues) {
-                result.add(valueCodec.deserialize(valueNode.getValue()));
-            }
-            return result;
-        }
-        return null;
-    }
-
-    @Override
-    public InstanceIdentifier.PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
-        checkArgument(getDomPathArgument().equals(arg));
+        // FIXME: BUG-4647 Refactor / redesign this to throw hard error, once BUG-4638 is fixed and will provide proper
+        //                 getDefaultValue() implementation.
         return null;
     }
-
-    @Override
-    public YangInstanceIdentifier.PathArgument serializePathArgument(final InstanceIdentifier.PathArgument arg) {
-        return getDomPathArgument();
-    }
-
-    @Override
-    public DataSchemaNode getSchema() {
-        return schema;
-    }
-
-    @Override
-    public ChildAddressabilitySummary getChildAddressabilitySummary() {
-        return ChildAddressabilitySummary.UNADDRESSABLE;
-    }
-
-    /**
-     * Return the default value object.
-     *
-     * @return The default value object, or null if the default value is not defined.
-     */
-    @Nullable Object defaultObject() {
-        return defaultObject;
-    }
 }