Bump odlparent to 6.0.0
[controller.git] / opendaylight / md-sal / sal-common-impl / src / main / java / org / opendaylight / controller / md / sal / common / impl / util / compat / DataNormalizationOperation.java
index 84705e7250b849f0533d66948f06e20c285e74e8..4dbd7db03e64992e3ae566fe9c6d7fb52fddb346 100644 (file)
@@ -8,9 +8,9 @@
 package org.opendaylight.controller.md.sal.common.impl.util.compat;
 
 import com.google.common.base.Optional;
-import com.google.common.collect.FluentIterable;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Iterables;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.Collections;
 import java.util.HashSet;
@@ -19,6 +19,8 @@ import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
+import org.eclipse.jdt.annotation.Nullable;
+import org.gaul.modernizer_maven_annotations.SuppressModernizer;
 import org.opendaylight.yangtools.concepts.Identifiable;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
@@ -49,7 +51,7 @@ import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
 public abstract class DataNormalizationOperation<T extends PathArgument> implements Identifiable<T> {
 
     private final T identifier;
-    private final Optional<DataSchemaNode> dataSchemaNode;
+    private final DataSchemaNode dataSchemaNode;
 
     @Override
     public T getIdentifier() {
@@ -58,11 +60,7 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
 
     protected DataNormalizationOperation(final T identifier, final SchemaNode schema) {
         this.identifier = identifier;
-        if (schema instanceof DataSchemaNode) {
-            this.dataSchemaNode = Optional.of((DataSchemaNode) schema);
-        } else {
-            this.dataSchemaNode = Optional.absent();
-        }
+        dataSchemaNode = schema instanceof DataSchemaNode ? (DataSchemaNode)schema : null;
     }
 
     public boolean isMixin() {
@@ -82,18 +80,16 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
 
     public abstract DataNormalizationOperation<?> getChild(QName child) throws DataNormalizationException;
 
-
     public abstract boolean isLeaf();
 
+    @SuppressModernizer
     public Optional<DataSchemaNode> getDataSchemaNode() {
-        // FIXME
-        return dataSchemaNode;
+        return Optional.fromNullable(dataSchemaNode);
     }
 
     private abstract static class SimpleTypeNormalization<T extends PathArgument>
             extends DataNormalizationOperation<T> {
-
-        protected SimpleTypeNormalization(final T identifier, final DataSchemaNode potential) {
+        SimpleTypeNormalization(final T identifier, final DataSchemaNode potential) {
             super(identifier,potential);
         }
 
@@ -119,15 +115,12 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
     }
 
     private static final class LeafNormalization extends SimpleTypeNormalization<NodeIdentifier> {
-
-        protected LeafNormalization(final LeafSchemaNode potential) {
+        LeafNormalization(final LeafSchemaNode potential) {
             super(new NodeIdentifier(potential.getQName()),potential);
         }
-
     }
 
     private static final class LeafListEntryNormalization extends SimpleTypeNormalization<NodeWithValue> {
-
         LeafListEntryNormalization(final LeafListSchemaNode potential) {
             super(new NodeWithValue(potential.getQName(), null),potential);
         }
@@ -140,8 +133,7 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
 
     private abstract static class CompositeNodeNormalizationOperation<T extends PathArgument>
             extends DataNormalizationOperation<T> {
-
-        protected CompositeNodeNormalizationOperation(final T identifier, final DataSchemaNode schema) {
+        CompositeNodeNormalizationOperation(final T identifier, final DataSchemaNode schema) {
             super(identifier,schema);
         }
 
@@ -149,18 +141,15 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public boolean isLeaf() {
             return false;
         }
-
-
     }
 
     private abstract static class DataContainerNormalizationOperation<T extends PathArgument>
             extends CompositeNodeNormalizationOperation<T> {
-
         private final DataNodeContainer schema;
         private final Map<QName, DataNormalizationOperation<?>> byQName;
         private final Map<PathArgument, DataNormalizationOperation<?>> byArg;
 
-        protected DataContainerNormalizationOperation(final T identifier, final DataNodeContainer schema,
+        DataContainerNormalizationOperation(final T identifier, final DataNodeContainer schema,
                 final DataSchemaNode node) {
             super(identifier,node);
             this.schema = schema;
@@ -212,12 +201,27 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
             return potential;
         }
 
+        private static DataNormalizationOperation<?> fromSchemaAndQNameChecked(final DataNodeContainer schema,
+                final QName child) throws DataNormalizationException {
+
+            final DataSchemaNode result = findChildSchemaNode(schema, child);
+            if (result == null) {
+                throw new DataNormalizationException(String.format(
+                        "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child,
+                        schema,schema.getChildNodes()));
+            }
+
+            // We try to look up if this node was added by augmentation
+            if (schema instanceof DataSchemaNode && result.isAugmenting()) {
+                return fromAugmentation(schema, (AugmentationTarget) schema, result);
+            }
+            return fromDataSchemaNode(result);
+        }
     }
 
     private static final class ListItemNormalization extends
             DataContainerNormalizationOperation<NodeIdentifierWithPredicates> {
-
-        protected ListItemNormalization(final NodeIdentifierWithPredicates identifier, final ListSchemaNode schema) {
+        ListItemNormalization(final NodeIdentifierWithPredicates identifier, final ListSchemaNode schema) {
             super(identifier, schema, schema);
         }
 
@@ -226,8 +230,7 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = Builders
                     .mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) currentArg);
-            for (final Entry<QName, Object> keyValue :
-                    ((NodeIdentifierWithPredicates) currentArg).getKeyValues().entrySet()) {
+            for (final Entry<QName, Object> keyValue : ((NodeIdentifierWithPredicates) currentArg).entrySet()) {
                 builder.addChild(Builders.leafBuilder()
                         //
                         .withNodeIdentifier(new NodeIdentifier(keyValue.getKey())).withValue(keyValue.getValue())
@@ -236,7 +239,6 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
             return builder.build();
         }
 
-
         @Override
         public boolean isKeyedEntry() {
             return true;
@@ -245,8 +247,7 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
 
     private static final class UnkeyedListItemNormalization
             extends DataContainerNormalizationOperation<NodeIdentifier> {
-
-        protected UnkeyedListItemNormalization(final ListSchemaNode schema) {
+        UnkeyedListItemNormalization(final ListSchemaNode schema) {
             super(new NodeIdentifier(schema.getQName()), schema,schema);
         }
 
@@ -255,12 +256,10 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
             return Builders.unkeyedListEntryBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
         }
-
     }
 
     private static final class ContainerNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
-
-        protected ContainerNormalization(final ContainerSchemaNode schema) {
+        ContainerNormalization(final ContainerSchemaNode schema) {
             super(new NodeIdentifier(schema.getQName()),schema, schema);
         }
 
@@ -269,13 +268,12 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
             return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
         }
-
     }
 
     private abstract static class MixinNormalizationOp<T extends PathArgument>
             extends CompositeNodeNormalizationOperation<T> {
 
-        protected MixinNormalizationOp(final T identifier, final DataSchemaNode schema) {
+        MixinNormalizationOp(final T identifier, final DataSchemaNode schema) {
             super(identifier,schema);
         }
 
@@ -283,10 +281,8 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public final boolean isMixin() {
             return true;
         }
-
     }
 
-
     private static final class OrderedLeafListMixinNormalization extends UnorderedLeafListMixinNormalization {
         OrderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
             super(potential);
@@ -336,22 +332,28 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
             super(augmentationIdentifierFrom(augmentation), augmentationProxy(augmentation,schema),null);
         }
 
+        private static DataNodeContainer augmentationProxy(final AugmentationSchemaNode augmentation,
+                final DataNodeContainer schema) {
+            final Set<DataSchemaNode> children = new HashSet<>();
+            for (final DataSchemaNode augNode : augmentation.getChildNodes()) {
+                children.add(schema.getDataChildByName(augNode.getQName()));
+            }
+            return new EffectiveAugmentationSchema(augmentation, children);
+        }
+
         @Override
         public boolean isMixin() {
             return true;
         }
 
-
-
         @Override
         protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema,
                 final QName child) {
-            final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
-            if (!potential.isPresent()) {
+            final DataSchemaNode result = findChildSchemaNode(schema, child);
+            if (result == null) {
                 return null;
             }
 
-            final DataSchemaNode result = potential.get();
             // We try to look up if this node was added by augmentation
             if (schema instanceof DataSchemaNode && result.isAugmenting()) {
                 return fromAugmentation(schema, (AugmentationTarget) schema, result);
@@ -368,11 +370,9 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
             return Builders.augmentationBuilder().withNodeIdentifier(getIdentifier()).build();
         }
-
     }
 
     private static class UnorderedMapMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
-
         private final ListItemNormalization innerNode;
 
         UnorderedMapMixinNormalization(final ListSchemaNode list) {
@@ -401,12 +401,9 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
             }
             return null;
         }
-
     }
 
-
     private static class UnkeyedListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
-
         private final UnkeyedListItemNormalization innerNode;
 
         UnkeyedListMixinNormalization(final ListSchemaNode list) {
@@ -434,11 +431,9 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
             }
             return null;
         }
-
     }
 
     private static final class OrderedMapMixinNormalization extends UnorderedMapMixinNormalization {
-
         OrderedMapMixinNormalization(final ListSchemaNode list) {
             super(list);
         }
@@ -447,15 +442,13 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
             return Builders.orderedMapBuilder().withNodeIdentifier(getIdentifier()).build();
         }
-
     }
 
     private static class ChoiceNodeNormalization extends MixinNormalizationOp<NodeIdentifier> {
-
         private final ImmutableMap<QName, DataNormalizationOperation<?>> byQName;
         private final ImmutableMap<PathArgument, DataNormalizationOperation<?>> byArg;
 
-        protected ChoiceNodeNormalization(final ChoiceSchemaNode schema) {
+        ChoiceNodeNormalization(final ChoiceSchemaNode schema) {
             super(new NodeIdentifier(schema.getQName()),schema);
             final ImmutableMap.Builder<QName, DataNormalizationOperation<?>> byQNameBuilder = ImmutableMap.builder();
             final ImmutableMap.Builder<PathArgument, DataNormalizationOperation<?>> byArgBuilder =
@@ -491,8 +484,7 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
     }
 
     private static class AnyXmlNormalization extends DataNormalizationOperation<NodeIdentifier> {
-
-        protected AnyXmlNormalization(final AnyXmlSchemaNode schema) {
+        AnyXmlNormalization(final AnyXmlSchemaNode schema) {
             super(new NodeIdentifier(schema.getQName()), schema);
         }
 
@@ -517,46 +509,20 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         }
     }
 
-    private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent,
-            final QName child) {
-        DataSchemaNode potential = parent.getDataChildByName(child);
-        if (potential == null) {
-            final Iterable<ChoiceSchemaNode> choices = FluentIterable.from(parent.getChildNodes())
-                    .filter(ChoiceSchemaNode.class);
-            potential = findChoice(choices, child);
-        }
-        return Optional.fromNullable(potential);
+    private static @Nullable DataSchemaNode findChildSchemaNode(final DataNodeContainer parent, final QName child) {
+        final DataSchemaNode potential = parent.getDataChildByName(child);
+        return potential != null ? potential : findChoice(parent, child);
     }
 
-    private static DataNormalizationOperation<?> fromSchemaAndQNameChecked(final DataNodeContainer schema,
-            final QName child) throws DataNormalizationException {
-
-        final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
-        if (!potential.isPresent()) {
-            throw new DataNormalizationException(String.format(
-                    "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child,
-                    schema,schema.getChildNodes()));
-        }
-
-        final DataSchemaNode result = potential.get();
-        // We try to look up if this node was added by augmentation
-        if (schema instanceof DataSchemaNode && result.isAugmenting()) {
-            return fromAugmentation(schema, (AugmentationTarget) schema, result);
-        }
-        return fromDataSchemaNode(result);
-    }
-
-    private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
-        ChoiceSchemaNode foundChoice = null;
-        choiceLoop: for (final ChoiceSchemaNode choice : choices) {
+    private static @Nullable ChoiceSchemaNode findChoice(final DataNodeContainer parent, final QName child) {
+        for (final ChoiceSchemaNode choice : Iterables.filter(parent.getChildNodes(), ChoiceSchemaNode.class)) {
             for (final CaseSchemaNode caze : choice.getCases().values()) {
-                if (findChildSchemaNode(caze, child).isPresent()) {
-                    foundChoice = choice;
-                    break choiceLoop;
+                if (findChildSchemaNode(caze, child) != null) {
+                    return choice;
                 }
             }
         }
-        return foundChoice;
+        return null;
     }
 
     public static AugmentationIdentifier augmentationIdentifierFrom(final AugmentationSchemaNode augmentation) {
@@ -567,15 +533,6 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
         return new AugmentationIdentifier(potentialChildren.build());
     }
 
-    private static DataNodeContainer augmentationProxy(final AugmentationSchemaNode augmentation,
-            final DataNodeContainer schema) {
-        final Set<DataSchemaNode> children = new HashSet<>();
-        for (final DataSchemaNode augNode : augmentation.getChildNodes()) {
-            children.add(schema.getDataChildByName(augNode.getQName()));
-        }
-        return new EffectiveAugmentationSchema(augmentation, children);
-    }
-
     /**
      * Returns a DataNormalizationOperation for provided child node.
      *
@@ -585,6 +542,8 @@ public abstract class DataNormalizationOperation<T extends PathArgument> impleme
      * otherwise returns a DataNormalizationOperation for child as
      * call for {@link #fromDataSchemaNode(DataSchemaNode)}.
      */
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
     private static DataNormalizationOperation<?> fromAugmentation(final DataNodeContainer parent,
             final AugmentationTarget parentAug, final DataSchemaNode child) {
         AugmentationSchemaNode augmentation = null;