Migrate rawStatementArgument()/getStatementSourceReference() callers
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / deviate / AbstractDeviateStatementSupport.java
index 7e5c90fc2dfa0495a006eaa015a55b8b9b1ef27c..f2a16708b087fe264bbc67007d924939076e2027 100644 (file)
@@ -7,10 +7,13 @@
  */
 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.deviate;
 
+import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Iterables;
 import com.google.common.collect.Maps;
 import com.google.common.collect.SetMultimap;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Objects;
@@ -19,14 +22,17 @@ import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.common.YangVersion;
 import org.opendaylight.yangtools.yang.model.api.DeviateKind;
 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
+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.meta.StatementDefinition;
+import org.opendaylight.yangtools.yang.model.api.stmt.DeviateEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.DeviateStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
-import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
-import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
+import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStatementSupport;
+import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
+import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
@@ -45,8 +51,8 @@ import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<DeviateKind, DeviateStatement,
-        EffectiveStatement<DeviateKind, DeviateStatement>> {
+abstract class AbstractDeviateStatementSupport
+        extends BaseStatementSupport<DeviateKind, DeviateStatement, DeviateEffectiveStatement> {
     private static final Logger LOG = LoggerFactory.getLogger(AbstractDeviateStatementSupport.class);
 
     private static final SubstatementValidator DEVIATE_NOT_SUPPORTED_SUBSTATEMENT_VALIDATOR =
@@ -99,25 +105,13 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
 
     @Override
     public final DeviateKind parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
-        return SourceException.throwIfNull(KEYWORD_TO_DEVIATE_MAP.get(value),
-            ctx.getStatementSourceReference(), "String '%s' is not valid deviate argument", value);
+        return SourceException.throwIfNull(KEYWORD_TO_DEVIATE_MAP.get(value), ctx.sourceReference(),
+            "String '%s' is not valid deviate argument", value);
     }
 
     @Override
-    public final DeviateStatement createDeclared(final StmtContext<DeviateKind, DeviateStatement, ?> ctx) {
-        return new DeviateStatementImpl(ctx);
-    }
-
-    @Override
-    public final EffectiveStatement<DeviateKind, DeviateStatement> createEffective(
-            final StmtContext<DeviateKind, DeviateStatement, EffectiveStatement<DeviateKind,
-                    DeviateStatement>> ctx) {
-        return new DeviateEffectiveStatementImpl(ctx);
-    }
-
-    @Override
-    public final void onFullDefinitionDeclared(final Mutable<DeviateKind, DeviateStatement,
-            EffectiveStatement<DeviateKind, DeviateStatement>> deviateStmtCtx) {
+    public final void onFullDefinitionDeclared(
+            final Mutable<DeviateKind, DeviateStatement, DeviateEffectiveStatement> deviateStmtCtx) {
         final DeviateKind deviateKind = deviateStmtCtx.getStatementArgument();
         getSubstatementValidatorForDeviate(deviateKind).validate(deviateStmtCtx);
 
@@ -131,13 +125,13 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
         final ModelActionBuilder deviateAction = deviateStmtCtx.newInferenceAction(
                 ModelProcessingPhase.EFFECTIVE_MODEL);
 
-        final Prerequisite<StmtContext<DeviateKind, DeviateStatement, EffectiveStatement<DeviateKind,
-                DeviateStatement>>> sourceCtxPrerequisite =
+        final Prerequisite<StmtContext<DeviateKind, DeviateStatement,
+            DeviateEffectiveStatement>> sourceCtxPrerequisite =
                 deviateAction.requiresCtx(deviateStmtCtx, ModelProcessingPhase.EFFECTIVE_MODEL);
 
         final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> targetCtxPrerequisite =
                 deviateAction.mutatesEffectiveCtxPath(deviateStmtCtx.getRoot(),
-                    ChildSchemaNodeNamespace.class, deviationTarget.getPathFromRoot());
+                    SchemaTreeNamespace.class, deviationTarget.getNodeIdentifiers());
 
         deviateAction.apply(new InferenceAction() {
             @Override
@@ -168,7 +162,7 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
 
             @Override
             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
-                throw new InferenceException(deviateStmtCtx.coerceParentContext().getStatementSourceReference(),
+                throw new InferenceException(deviateStmtCtx.coerceParentContext().sourceReference(),
                     "Deviation target '%s' not found.", deviationTarget);
             }
         });
@@ -194,6 +188,24 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
         return null;
     }
 
+    @Override
+    protected final DeviateStatement createDeclared(final StmtContext<DeviateKind, DeviateStatement, ?> ctx,
+            final ImmutableList<? extends DeclaredStatement<?>> substatements) {
+        return new DeviateStatementImpl(ctx.coerceRawStatementArgument(), ctx.coerceStatementArgument(), substatements);
+    }
+
+    @Override
+    protected final DeviateStatement createEmptyDeclared(final StmtContext<DeviateKind, DeviateStatement, ?> ctx) {
+        // This is exceedingly unlikely, just reuse the implementation
+        return createDeclared(ctx, ImmutableList.of());
+    }
+
+    @Override
+    protected DeviateEffectiveStatement createEffective(final Current<DeviateKind, DeviateStatement> stmt,
+            final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
+        return new DeviateEffectiveStatementImpl(stmt.declared(), substatements);
+    }
+
     protected SubstatementValidator getSubstatementValidatorForDeviate(final DeviateKind deviateKind) {
         switch (deviateKind) {
             case NOT_SUPPORTED:
@@ -210,8 +222,8 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
         }
     }
 
-    private static boolean isDeviationSupported(final Mutable<DeviateKind, DeviateStatement,
-            EffectiveStatement<DeviateKind, DeviateStatement>> deviateStmtCtx,
+    private static boolean isDeviationSupported(
+            final Mutable<DeviateKind, DeviateStatement, DeviateEffectiveStatement> deviateStmtCtx,
             final SchemaNodeIdentifier deviationTarget) {
         final SetMultimap<QNameModule, QNameModule> modulesDeviatedByModules = deviateStmtCtx.getFromNamespace(
                 ModulesDeviatedByModules.class, SupportedModules.SUPPORTED_MODULES);
@@ -221,7 +233,7 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
 
         final QNameModule currentModule = deviateStmtCtx.getFromNamespace(ModuleCtxToModuleQName.class,
                 deviateStmtCtx.getRoot());
-        final QNameModule targetModule = deviationTarget.getLastComponent().getModule();
+        final QNameModule targetModule = Iterables.getLast(deviationTarget.getNodeIdentifiers()).getModule();
 
         final Set<QNameModule> deviationModulesSupportedByTargetModule = modulesDeviatedByModules.get(targetModule);
         if (deviationModulesSupportedByTargetModule != null) {
@@ -231,6 +243,8 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
         return false;
     }
 
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
     private static void performDeviateAdd(final StatementContextBase<?, ?, ?> deviateStmtCtx,
             final StatementContextBase<?, ?, ?> targetCtx) {
         for (Mutable<?, ?, ?> originalStmtCtx : deviateStmtCtx.mutableDeclaredSubstatements()) {
@@ -242,12 +256,12 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
     private static void addStatement(final Mutable<?, ?, ?> stmtCtxToBeAdded,
             final StatementContextBase<?, ?, ?> targetCtx) {
         if (!StmtContextUtils.isUnknownStatement(stmtCtxToBeAdded)) {
-            final StatementDefinition stmtToBeAdded = stmtCtxToBeAdded.getPublicDefinition();
+            final StatementDefinition stmtToBeAdded = stmtCtxToBeAdded.publicDefinition();
             if (SINGLETON_STATEMENTS.contains(stmtToBeAdded) || YangStmtMapping.DEFAULT.equals(stmtToBeAdded)
-                    && YangStmtMapping.LEAF.equals(targetCtx.getPublicDefinition())) {
+                    && YangStmtMapping.LEAF.equals(targetCtx.publicDefinition())) {
                 for (final StmtContext<?, ?, ?> targetCtxSubstatement : targetCtx.allSubstatements()) {
-                    InferenceException.throwIf(stmtToBeAdded.equals(targetCtxSubstatement.getPublicDefinition()),
-                        stmtCtxToBeAdded.getStatementSourceReference(),
+                    InferenceException.throwIf(stmtToBeAdded.equals(targetCtxSubstatement.publicDefinition()),
+                        stmtCtxToBeAdded.sourceReference(),
                         "Deviation cannot add substatement %s to target node %s because it is already defined "
                         + "in target and can appear only once.",
                         stmtToBeAdded.getStatementName(), targetCtx.getStatementArgument());
@@ -258,6 +272,8 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
         copyStatement(stmtCtxToBeAdded, targetCtx);
     }
 
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
     private static void performDeviateReplace(final StatementContextBase<?, ?, ?> deviateStmtCtx,
             final StatementContextBase<?, ?, ?> targetCtx) {
         for (Mutable<?, ?, ?> originalStmtCtx : deviateStmtCtx.mutableDeclaredSubstatements()) {
@@ -268,18 +284,18 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
 
     private static void replaceStatement(final Mutable<?, ?, ?> stmtCtxToBeReplaced,
             final StatementContextBase<?, ?, ?> targetCtx) {
-        final StatementDefinition stmtToBeReplaced = stmtCtxToBeReplaced.getPublicDefinition();
+        final StatementDefinition stmtToBeReplaced = stmtCtxToBeReplaced.publicDefinition();
 
         if (YangStmtMapping.DEFAULT.equals(stmtToBeReplaced)
-                && YangStmtMapping.LEAF_LIST.equals(targetCtx.getPublicDefinition())) {
+                && YangStmtMapping.LEAF_LIST.equals(targetCtx.publicDefinition())) {
             LOG.error("Deviation cannot replace substatement {} in target leaf-list {} because a leaf-list can "
                     + "have multiple default statements. At line: {}", stmtToBeReplaced.getStatementName(),
-                    targetCtx.getStatementArgument(), stmtCtxToBeReplaced.getStatementSourceReference());
+                    targetCtx.getStatementArgument(), stmtCtxToBeReplaced.sourceReference());
             return;
         }
 
         for (final StmtContext<?, ?, ?> targetCtxSubstatement : targetCtx.effectiveSubstatements()) {
-            if (stmtToBeReplaced.equals(targetCtxSubstatement.getPublicDefinition())) {
+            if (stmtToBeReplaced.equals(targetCtxSubstatement.publicDefinition())) {
                 targetCtx.removeStatementFromEffectiveSubstatements(stmtToBeReplaced);
                 copyStatement(stmtCtxToBeReplaced, targetCtx);
                 return;
@@ -287,7 +303,7 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
         }
 
         for (final Mutable<?, ?, ?> targetCtxSubstatement : targetCtx.mutableDeclaredSubstatements()) {
-            if (stmtToBeReplaced.equals(targetCtxSubstatement.getPublicDefinition())) {
+            if (stmtToBeReplaced.equals(targetCtxSubstatement.publicDefinition())) {
                 targetCtxSubstatement.setIsSupportedToBuildEffective(false);
                 copyStatement(stmtCtxToBeReplaced, targetCtx);
                 return;
@@ -302,11 +318,13 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
             return;
         }
 
-        throw new InferenceException(stmtCtxToBeReplaced.getStatementSourceReference(), "Deviation cannot replace "
+        throw new InferenceException(stmtCtxToBeReplaced.sourceReference(), "Deviation cannot replace "
                 + "substatement %s in target node %s because it does not exist in target node.",
                 stmtToBeReplaced.getStatementName(), targetCtx.getStatementArgument());
     }
 
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
     private static void performDeviateDelete(final StatementContextBase<?, ?, ?> deviateStmtCtx,
             final StatementContextBase<?, ?, ?> targetCtx) {
         for (Mutable<?, ?, ?> originalStmtCtx : deviateStmtCtx.mutableDeclaredSubstatements()) {
@@ -317,20 +335,20 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
 
     private static void deleteStatement(final StmtContext<?, ?, ?> stmtCtxToBeDeleted,
             final StatementContextBase<?, ?, ?> targetCtx) {
-        final StatementDefinition stmtToBeDeleted = stmtCtxToBeDeleted.getPublicDefinition();
-        final String stmtArgument = stmtCtxToBeDeleted.rawStatementArgument();
+        final StatementDefinition stmtToBeDeleted = stmtCtxToBeDeleted.publicDefinition();
+        final String stmtArgument = stmtCtxToBeDeleted.rawArgument();
 
         for (final Mutable<?, ?, ?> targetCtxSubstatement : targetCtx.mutableEffectiveSubstatements()) {
-            if (statementsAreEqual(stmtToBeDeleted, stmtArgument, targetCtxSubstatement.getPublicDefinition(),
-                    targetCtxSubstatement.rawStatementArgument())) {
+            if (statementsAreEqual(stmtToBeDeleted, stmtArgument, targetCtxSubstatement.publicDefinition(),
+                    targetCtxSubstatement.rawArgument())) {
                 targetCtx.removeStatementFromEffectiveSubstatements(stmtToBeDeleted, stmtArgument);
                 return;
             }
         }
 
         for (final Mutable<?, ?, ?> targetCtxSubstatement : targetCtx.mutableDeclaredSubstatements()) {
-            if (statementsAreEqual(stmtToBeDeleted, stmtArgument, targetCtxSubstatement.getPublicDefinition(),
-                    targetCtxSubstatement.rawStatementArgument())) {
+            if (statementsAreEqual(stmtToBeDeleted, stmtArgument, targetCtxSubstatement.publicDefinition(),
+                    targetCtxSubstatement.rawArgument())) {
                 targetCtxSubstatement.setIsSupportedToBuildEffective(false);
                 return;
             }
@@ -338,7 +356,7 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
 
         LOG.error("Deviation cannot delete substatement {} with argument '{}' in target node {} because it does "
                 + "not exist in the target node. At line: {}", stmtToBeDeleted.getStatementName(), stmtArgument,
-                targetCtx.getStatementArgument(), stmtCtxToBeDeleted.getStatementSourceReference());
+                targetCtx.getStatementArgument(), stmtCtxToBeDeleted.sourceReference());
     }
 
     private static void copyStatement(final Mutable<?, ?, ?> stmtCtxToBeCopied,
@@ -360,24 +378,24 @@ abstract class AbstractDeviateStatementSupport extends AbstractStatementSupport<
     private static void validateDeviationTarget(final StmtContext<?, ?, ?> deviateSubStmtCtx,
             final StmtContext<?, ?, ?> targetCtx) {
         InferenceException.throwIf(!isSupportedDeviationTarget(deviateSubStmtCtx, targetCtx,
-                targetCtx.getRootVersion()), deviateSubStmtCtx.getStatementSourceReference(),
-                "%s is not a valid deviation target for substatement %s.",
-                targetCtx.getStatementArgument(), deviateSubStmtCtx.getPublicDefinition().getStatementName());
+            targetCtx.getRootVersion()), deviateSubStmtCtx.sourceReference(),
+            "%s is not a valid deviation target for substatement %s.", targetCtx.argument(),
+            deviateSubStmtCtx.publicDefinition().getStatementName());
     }
 
     private static boolean isSupportedDeviationTarget(final StmtContext<?, ?, ?> deviateSubstatementCtx,
             final StmtContext<?, ?, ?> deviateTargetCtx, final YangVersion yangVersion) {
         Set<StatementDefinition> supportedDeviationTargets =
                 YangValidationBundles.SUPPORTED_DEVIATION_TARGETS.get(deviateTargetCtx.getRootVersion(),
-                        deviateSubstatementCtx.getPublicDefinition());
+                        deviateSubstatementCtx.publicDefinition());
 
         if (supportedDeviationTargets == null) {
             supportedDeviationTargets = YangValidationBundles.SUPPORTED_DEVIATION_TARGETS.get(YangVersion.VERSION_1,
-                    deviateSubstatementCtx.getPublicDefinition());
+                    deviateSubstatementCtx.publicDefinition());
         }
 
         // if supportedDeviationTargets is null, it means that the deviate substatement is an unknown statement
         return supportedDeviationTargets == null || supportedDeviationTargets.contains(
-                deviateTargetCtx.getPublicDefinition());
+                deviateTargetCtx.publicDefinition());
     }
 }