Bug 3874: Support of yang modeled AnyXML - XML deserialization
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / spi / meta / StmtContextUtils.java
index eccbaca07d4bc14093b6a60b8b17f76e9c4280a5..77b285f16a9a3137dd17a1ac8b6fb3acee136515 100644 (file)
@@ -8,47 +8,38 @@
 package org.opendaylight.yangtools.yang.parser.spi.meta;
 
 import com.google.common.base.Function;
-import com.google.common.base.Predicate;
 import com.google.common.base.Splitter;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.ImmutableSet.Builder;
 import java.util.Collection;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.TypeOfCopy;
 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnknownStatementImpl;
 
 public final class StmtContextUtils {
+    public static final Splitter LIST_KEY_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
 
-    public static final char LIST_KEY_SEPARATOR = ' ';
-    private static final Splitter KEY_SPLITTER = Splitter.on(LIST_KEY_SEPARATOR).omitEmptyStrings().trimResults();
-
-    private static final Function<StmtContext<?, ?, ?>, DeclaredStatement<?>> BUILD_DECLARED = new Function<StmtContext<?, ?, ?>, DeclaredStatement<?>>() {
+    private static final Function<StmtContext<?, ?,?>, DeclaredStatement<?>> BUILD_DECLARED =
+            new Function<StmtContext<?,?,?>, DeclaredStatement<?>>() {
         @Override
         public DeclaredStatement<?> apply(final StmtContext<?, ?, ?> input) {
             return input.buildDeclared();
         }
     };
 
-    private static final Function<StmtContext<?, ?, ?>, EffectiveStatement<?, ?>> BUILD_EFFECTIVE = new Function<StmtContext<?, ?, ?>, EffectiveStatement<?, ?>>() {
+    private static final Function<StmtContext<?, ?,?>, EffectiveStatement<?,?>> BUILD_EFFECTIVE =
+            new Function<StmtContext<?,?,?>, EffectiveStatement<?,?>>() {
         @Override
         public EffectiveStatement<?, ?> apply(final StmtContext<?, ?, ?> input) {
             return input.buildEffective();
         }
     };
 
-    public static final Predicate<StmtContext<?, ?, ?>> IS_SUPPORTED_TO_BUILD_EFFECTIVE = new Predicate<StmtContext<?, ?, ?>>() {
-        @Override
-        public boolean apply(StmtContext<?, ?, ?> input) {
-            return input.isSupportedToBuildEffective();
-        }
-    };
-
     private StmtContextUtils() {
         throw new UnsupportedOperationException("Utility class");
     }
@@ -59,12 +50,12 @@ public final class StmtContextUtils {
     }
 
     @SuppressWarnings("unchecked")
-    public static final <E extends EffectiveStatement<?, ?>> Function<StmtContext<?, ?, ? extends E>, E> buildEffective() {
+    public static <E extends EffectiveStatement<?, ?>> Function<StmtContext<?, ?, ? extends E>, E> buildEffective() {
         return Function.class.cast(BUILD_EFFECTIVE);
     }
 
     @SuppressWarnings("unchecked")
-    public static final <AT, DT extends DeclaredStatement<AT>> AT firstAttributeOf(
+    public static <AT, DT extends DeclaredStatement<AT>> AT firstAttributeOf(
             final Iterable<? extends StmtContext<?, ?, ?>> contexts, final Class<DT> declaredType) {
         for (StmtContext<?, ?, ?> ctx : contexts) {
             if (producesDeclared(ctx, declaredType)) {
@@ -75,94 +66,108 @@ public final class StmtContextUtils {
     }
 
     @SuppressWarnings("unchecked")
-    public static final <AT, DT extends DeclaredStatement<AT>> AT firstAttributeOf(final StmtContext<?, ?, ?> ctx,
+    public static <AT, DT extends DeclaredStatement<AT>> AT firstAttributeOf(final StmtContext<?, ?, ?> ctx,
             final Class<DT> declaredType) {
+        return producesDeclared(ctx, declaredType) ? (AT) ctx.getStatementArgument() : null;
+    }
 
-        if (producesDeclared(ctx, declaredType)) {
-            return (AT) ctx.getStatementArgument();
+    @SuppressWarnings("unchecked")
+    public static <AT,DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstDeclaredSubstatement(
+            final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
+        for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
+            if (producesDeclared(subStmtContext,declaredType)) {
+                return (StmtContext<AT, ?, ?>) subStmtContext;
+            }
         }
-
         return null;
     }
 
     @SuppressWarnings("unchecked")
-    public static final <AT, DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstDeclaredSubstatement(
-            StmtContext<?, ?, ?> stmtContext, Class<DT> declaredType) {
-        Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements = stmtContext.declaredSubstatements();
-        for (StmtContext<?, ?, ?> subStmtContext : declaredSubstatements) {
-            if (producesDeclared(subStmtContext, declaredType)) {
+    public static <AT,DT extends DeclaredStatement<AT>> Collection<StmtContext<AT, DT, ?>> findAllDeclaredSubstatement(
+            final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
+        ImmutableList.Builder<StmtContext<AT, DT, ?>> listBuilder = ImmutableList.builder();
+        for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
+            if (producesDeclared(subStmtContext,declaredType)) {
+                listBuilder.add((StmtContext<AT, DT, ?>) subStmtContext);
+            }
+        }
+        return listBuilder.build();
+    }
+
+    @SuppressWarnings("unchecked")
+    public static <AT,DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstEffectiveSubstatement(
+            final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
+        for (StmtContext<?, ?, ?> subStmtContext : stmtContext.effectiveSubstatements()) {
+            if (producesDeclared(subStmtContext,declaredType)) {
                 return (StmtContext<AT, ?, ?>) subStmtContext;
             }
         }
         return null;
     }
 
-    public static final StmtContext<?, ?, ?> findFirstDeclaredSubstatement(final StmtContext<?, ?, ?> stmtContext,
-            int startIndex, final Class<? extends DeclaredStatement<?>>... types) {
+    public static <AT,DT extends DeclaredStatement<AT>> StmtContext<AT, ?, ?> findFirstSubstatement(
+            final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
+        StmtContext<AT, ?, ?> declaredSubstatement = findFirstDeclaredSubstatement(stmtContext, declaredType);
+        return declaredSubstatement != null ? declaredSubstatement : findFirstEffectiveSubstatement(stmtContext, declaredType);
+    }
 
+    @SafeVarargs
+    public static StmtContext<?, ?, ?> findFirstDeclaredSubstatement(final StmtContext<?, ?, ?> stmtContext,
+            int startIndex, final Class<? extends DeclaredStatement<?>>... types) {
         if (startIndex >= types.length) {
             return null;
         }
 
-        Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements = stmtContext.declaredSubstatements();
-        for (StmtContext<?, ?, ?> subStmtContext : declaredSubstatements) {
-            if (producesDeclared(subStmtContext, types[startIndex])) {
-                if (startIndex + 1 == types.length) {
-                    return subStmtContext;
-                } else {
-                    return findFirstDeclaredSubstatement(subStmtContext, ++startIndex, types);
-                }
+        for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
+            if (producesDeclared(subStmtContext,types[startIndex])) {
+                return startIndex + 1 == types.length ? subStmtContext
+                        : findFirstDeclaredSubstatement(subStmtContext, ++startIndex, types);
             }
         }
         return null;
     }
 
-    public static final <DT extends DeclaredStatement<?>> StmtContext<?, ?, ?> findFirstDeclaredSubstatementOnSublevel(
+    public static <DT extends DeclaredStatement<?>> StmtContext<?, ?, ?> findFirstDeclaredSubstatementOnSublevel(
             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType, int sublevel) {
-        Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements = stmtContext.declaredSubstatements();
-        for (StmtContext<?, ?, ?> subStmtContext : declaredSubstatements) {
+        for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
             if (sublevel == 1 && producesDeclared(subStmtContext, declaredType)) {
                 return subStmtContext;
-            } else {
-                if (sublevel > 1) {
-                    StmtContext<?, ?, ?> result = findFirstDeclaredSubstatementOnSublevel(subStmtContext, declaredType,
-                            --sublevel);
-                    if (result != null) {
-                        return result;
-                    }
+            }
+            if (sublevel > 1) {
+                final StmtContext<?, ?, ?> result = findFirstDeclaredSubstatementOnSublevel(
+                    subStmtContext, declaredType, --sublevel);
+                if (result != null) {
+                    return result;
                 }
             }
         }
+
         return null;
     }
 
-    public static final <DT extends DeclaredStatement<?>> StmtContext<?, ?, ?> findDeepFirstDeclaredSubstatement(
+    public static <DT extends DeclaredStatement<?>> StmtContext<?, ?, ?> findDeepFirstDeclaredSubstatement(
             final StmtContext<?, ?, ?> stmtContext, final Class<DT> declaredType) {
-
-        Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements = stmtContext.declaredSubstatements();
-
-        for (StmtContext<?, ?, ?> subStmtContext : declaredSubstatements) {
+        for (StmtContext<?, ?, ?> subStmtContext : stmtContext.declaredSubstatements()) {
             if (producesDeclared(subStmtContext, declaredType)) {
                 return subStmtContext;
-            } else {
-                StmtContext<?, ?, ?> result = findDeepFirstDeclaredSubstatement(subStmtContext, declaredType);
-                if (result != null) {
-                    return result;
-                }
+            }
 
+            final StmtContext<?, ?, ?> result = findDeepFirstDeclaredSubstatement(subStmtContext, declaredType);
+            if (result != null) {
+                return result;
             }
         }
+
         return null;
     }
 
-    public static final boolean producesDeclared(final StmtContext<?, ?, ?> ctx,
+    public static boolean producesDeclared(final StmtContext<?, ?, ?> ctx,
             final Class<? extends DeclaredStatement<?>> type) {
         return type.isAssignableFrom(ctx.getPublicDefinition().getDeclaredRepresentationClass());
     }
 
-    public static boolean isInExtensionBody(StmtContext<?, ?, ?> stmtCtx) {
-
-        StmtContext<?, ?, ?> current = stmtCtx;
+    public static boolean isInExtensionBody(final StmtContext<?,?,?> stmtCtx) {
+        StmtContext<?,?,?> current = stmtCtx;
         while (!current.getParentContext().isRootContext()) {
             current = current.getParentContext();
             if (producesDeclared(current, UnknownStatementImpl.class)) {
@@ -173,36 +178,29 @@ public final class StmtContextUtils {
         return false;
     }
 
-    public static boolean isUnknownStatement(StmtContext<?, ?, ?> stmtCtx) {
+    public static boolean isUnknownStatement(final StmtContext<?, ?, ?> stmtCtx) {
         return producesDeclared(stmtCtx, UnknownStatementImpl.class);
     }
 
-    public static Set<TypeOfCopy> getCopyTypesFromOriginal(StmtContext<?, ?, ?> ctx) {
-
-        Set<TypeOfCopy> copyTypesFromOriginal = new HashSet<>();
-        StmtContext<?, ?, ?> current = ctx;
-
-        while (current.getOriginalCtx() != null) {
-            copyTypesFromOriginal.add(current.getTypeOfCopy());
-            current = current.getOriginalCtx();
-        }
-
-        return copyTypesFromOriginal;
-    }
-
     public static Collection<SchemaNodeIdentifier> replaceModuleQNameForKey(
-            StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?> keyStmtCtx, QNameModule newQNameModule) {
-
-        List<String> keyTokens = KEY_SPLITTER.splitToList(keyStmtCtx.rawStatementArgument());
-
-        Set<SchemaNodeIdentifier> newKeys = new HashSet<>();
-
-        for (String keyToken : keyTokens) {
-            QName keyQName = QName.create(newQNameModule, keyToken);
-            SchemaNodeIdentifier keyIdentifier = SchemaNodeIdentifier.create(false, keyQName);
-            newKeys.add(keyIdentifier);
+            final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?> keyStmtCtx,
+            final QNameModule newQNameModule) {
+
+        final Builder<SchemaNodeIdentifier> builder = ImmutableSet.builder();
+        boolean replaced = false;
+        for (SchemaNodeIdentifier arg : keyStmtCtx.getStatementArgument()) {
+            final QName qname = arg.getLastComponent();
+            if (!newQNameModule.equals(qname)) {
+                final QName newQname = keyStmtCtx.getFromNamespace(QNameCacheNamespace.class,
+                    QName.create(newQNameModule, qname.getLocalName()));
+                builder.add(SchemaNodeIdentifier.create(false, newQname));
+                replaced = true;
+            } else {
+                builder.add(arg);
+            }
         }
 
-        return newKeys;
+        // This makes sure we reuse the collection when a grouping is instantiated in the same module
+        return replaced ? builder.build() : keyStmtCtx.getStatementArgument();
     }
 }