Refactor InferenceAction
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / IncludeStatementImpl.java
index 509f462975a472ea637abd52217f358b39c4d7bf..7d4adc98f981c98a408ab5fd9c48f11955addaf9 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -10,35 +10,40 @@ package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
 
-import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.IncludeEffectiveStatementImpl;
-
-import java.net.URI;
-import java.text.ParseException;
 import java.util.Collection;
 import java.util.Date;
+import java.util.Optional;
+import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
-import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
+import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
-import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleIdentifierImpl;
+import org.opendaylight.yangtools.yang.model.util.ModuleIdentifierImpl;
 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
 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;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
-import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
-import com.google.common.base.Optional;
+import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
+import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToIdentifier;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.IncludeEffectiveStatementImpl;
 
 public class IncludeStatementImpl extends AbstractDeclaredStatement<String> implements IncludeStatement {
+    private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
+        YangStmtMapping.INCLUDE).addOptional(YangStmtMapping.REVISION_DATE).build();
 
-    protected IncludeStatementImpl(StmtContext<String, IncludeStatement, ?> context) {
+    protected IncludeStatementImpl(final StmtContext<String, IncludeStatement, ?> context) {
         super(context);
     }
 
@@ -46,81 +51,85 @@ public class IncludeStatementImpl extends AbstractDeclaredStatement<String> impl
             AbstractStatementSupport<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> {
 
         public Definition() {
-            super(Rfc6020Mapping.INCLUDE);
+            super(YangStmtMapping.INCLUDE);
         }
 
         @Override
-        public String parseArgumentValue(StmtContext<?, ?, ?> ctx, String value) {
+        public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
             return value;
         }
 
         @Override
-        public IncludeStatement createDeclared(StmtContext<String, IncludeStatement, ?> ctx) {
+        public IncludeStatement createDeclared(final StmtContext<String, IncludeStatement, ?> ctx) {
             return new IncludeStatementImpl(ctx);
         }
 
         @Override
         public EffectiveStatement<String, IncludeStatement> createEffective(
-                StmtContext<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> ctx) {
+                final StmtContext<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> ctx) {
             return new IncludeEffectiveStatementImpl(ctx);
         }
 
+        @Override
+        public void onPreLinkageDeclared(
+                final StmtContext.Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt) {
+            stmt.addRequiredModule(getIncludeSubmoduleIdentifier(stmt));
+        }
+
         @Override
         public void onLinkageDeclared(
-                final Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt)
-                throws SourceException {
+                final Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt) {
             final ModuleIdentifier includeSubmoduleIdentifier = getIncludeSubmoduleIdentifier(stmt);
 
-            ModelActionBuilder includeAction = stmt.newInferenceAction(SOURCE_LINKAGE);
+            final ModelActionBuilder includeAction = stmt.newInferenceAction(SOURCE_LINKAGE);
             final Prerequisite<StmtContext<?, ?, ?>> requiresCtxPrerequisite = includeAction.requiresCtx(stmt,
                     SubmoduleNamespace.class, includeSubmoduleIdentifier, SOURCE_LINKAGE);
-            final Prerequisite<Mutable<?, ?, ?>> mutatesCtxPrerequisite = includeAction.mutatesCtx(stmt.getRoot(),
-                    SOURCE_LINKAGE);
 
             includeAction.apply(new InferenceAction() {
-
                 @Override
-                public void apply() throws InferenceException {
-                    StmtContext<?, ?, ?> includedSubmoduleStmt = requiresCtxPrerequisite.get();
+                public void apply(final InferenceContext ctx) {
+                    final StmtContext<?, ?, ?> includedSubModuleContext = requiresCtxPrerequisite.resolve(ctx);
 
-                    mutatesCtxPrerequisite.get().addToNs(IncludedModuleContext.class, includeSubmoduleIdentifier,
-                            includedSubmoduleStmt);
+                    stmt.addToNs(IncludedModuleContext.class, includeSubmoduleIdentifier,
+                            includedSubModuleContext);
+                    stmt.addToNs(IncludedSubmoduleNameToIdentifier.class,
+                            stmt.getStatementArgument(), includeSubmoduleIdentifier);
                 }
 
                 @Override
-                public void prerequisiteFailed(Collection<? extends Prerequisite<?>> failed) throws InferenceException {
-                    if (failed.contains(requiresCtxPrerequisite)) {
-                        throw new InferenceException("Included submodule was not found: "+stmt.getStatementArgument(), stmt
-                                .getStatementSourceReference());
-                    }
+                public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
+                    InferenceException.throwIf(failed.contains(requiresCtxPrerequisite),
+                        stmt.getStatementSourceReference(),
+                        "Included submodule '%s' was not found: ", stmt.getStatementArgument());
                 }
             });
         }
 
-        private static ModuleIdentifier getIncludeSubmoduleIdentifier(Mutable<String, IncludeStatement, ?> stmt) {
+        private static ModuleIdentifier getIncludeSubmoduleIdentifier(final StmtContext<String, IncludeStatement, ?> stmt) {
 
-            String subModuleName = stmt.getStatementArgument();
-            String revisionArg = firstAttributeOf(stmt.declaredSubstatements(), RevisionDateStatement.class);
-            final Optional<Date> revision;
-            if (revisionArg != null) {
-                try {
-                    revision = Optional.of(SimpleDateFormatUtil.getRevisionFormat().parse(revisionArg));
-                } catch (ParseException e) {
-                    throw new IllegalArgumentException(e);
-                }
-            } else {
-                revision = Optional.of(SimpleDateFormatUtil.DEFAULT_DATE_IMP);
+            final String subModuleName = stmt.getStatementArgument();
+
+            Date revisionDate = firstAttributeOf(stmt.declaredSubstatements(), RevisionDateStatement.class);
+            if (revisionDate == null) {
+                revisionDate = SimpleDateFormatUtil.DEFAULT_DATE_IMP;
             }
 
-            return new ModuleIdentifierImpl(subModuleName, Optional.<URI> absent(), revision);
+            return ModuleIdentifierImpl.create(subModuleName, Optional.empty(), Optional.of(revisionDate));
+        }
+
+        @Override
+        protected SubstatementValidator getSubstatementValidator() {
+            return SUBSTATEMENT_VALIDATOR;
         }
     }
 
+    @Nonnull
     @Override
     public String getModule() {
         return argument();
     }
 
+    @Nonnull
     @Override
     public PrefixStatement getPrefix() {
         return firstDeclared(PrefixStatement.class);
@@ -131,4 +140,14 @@ public class IncludeStatementImpl extends AbstractDeclaredStatement<String> impl
         return firstDeclared(RevisionDateStatement.class);
     }
 
-}
\ No newline at end of file
+    @Override
+    public DescriptionStatement getDescription() {
+        return firstDeclared(DescriptionStatement.class);
+    }
+
+    @Override
+    public ReferenceStatement getReference() {
+        return firstDeclared(ReferenceStatement.class);
+    }
+
+}