YANGTOOLS-706: split out rfc8040-model-api

[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / effective / AbstractEffectiveModule.java

diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/AbstractEffectiveModule.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/AbstractEffectiveModule.java
index 871d2878e9050ebb8af5acca1d686a893e7dd047..6d4b993bfa19b0fe6d4480612b79f6b79a668658 100644 (file)
--- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/AbstractEffectiveModule.java
+++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/effective/AbstractEffectiveModule.java
@@ -7,7 +7,10 @@
  */
 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective;
 
-import com.google.common.base.Preconditions;
+import static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.base.MoreObjects;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
@@ -15,19 +18,20 @@ import com.google.common.collect.Iterables;
 import java.net.URI;
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Date;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.concepts.SemVer;
 import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.Revision;
 import org.opendaylight.yangtools.yang.common.YangVersion;
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
+import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Deviation;
@@ -36,7 +40,6 @@ import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
@@ -48,12 +51,12 @@ 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.stmt.SubmoduleStatement;
-import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
 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.IncludedSubmoduleNameToIdentifier;
+import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
+import org.opendaylight.yangtools.yang.parser.stmt.openconfig.OpenconfigVersionEffectiveStatement;
 
 abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
         AbstractEffectiveDocumentedNode<String, D> implements Module, MutableStatement {
@@ -65,7 +68,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     private final Set<ModuleImport> imports;
     private final Set<FeatureDefinition> features;
     private final Set<NotificationDefinition> notifications;
-    private final Set<AugmentationSchema> augmentations;
+    private final Set<AugmentationSchemaNode> augmentations;
     private final Set<RpcDefinition> rpcs;
     private final Set<Deviation> deviations;
     private final List<ExtensionDefinition> extensionNodes;
@@ -105,9 +108,9 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
                 firstEffective(YangVersionEffectiveStatementImpl.class);
         this.yangVersion = yangVersionStmt == null ? YangVersion.VERSION_1 : yangVersionStmt.argument();
 
-        final OpenconfigVersionEffectiveStatementImpl semanticVersionStmt =
-                firstEffective(OpenconfigVersionEffectiveStatementImpl.class);
-        this.semanticVersion = semanticVersionStmt == null ? DEFAULT_SEMANTIC_VERSION : semanticVersionStmt.argument();
+        final OpenconfigVersionEffectiveStatement semanticVersionStmt =
+                firstEffective(OpenconfigVersionEffectiveStatement.class);
+        this.semanticVersion = semanticVersionStmt == null ? null : semanticVersionStmt.argument();
 
         final OrganizationEffectiveStatementImpl organizationStmt =
                 firstEffective(OrganizationEffectiveStatementImpl.class);
@@ -118,8 +121,8 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
 
         // init submodules and substatements of submodules
         final List<EffectiveStatement<?, ?>> substatementsOfSubmodules;
-        final Map<String, ModuleIdentifier> includedSubmodulesMap = ctx
-                .getAllFromCurrentStmtCtxNamespace(IncludedSubmoduleNameToIdentifier.class);
+        final Map<String, StmtContext<?, ?, ?>> includedSubmodulesMap = ctx
+                .getAllFromCurrentStmtCtxNamespace(IncludedSubmoduleNameToModuleCtx.class);
 
         if (includedSubmodulesMap == null || includedSubmodulesMap.isEmpty()) {
             this.submodules = ImmutableSet.of();
@@ -131,14 +134,10 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
              * for modules. In case of submodules it does not make sense because
              * of possible circular chains of includes between submodules.
              */
-            final Collection<ModuleIdentifier> includedSubmodules = includedSubmodulesMap.values();
+            final Collection<StmtContext<?, ?, ?>> includedSubmodules = includedSubmodulesMap.values();
             final Set<Module> submodulesInit = new HashSet<>();
             final List<EffectiveStatement<?, ?>> substatementsOfSubmodulesInit = new ArrayList<>();
-            for (final ModuleIdentifier submoduleIdentifier : includedSubmodules) {
-                @SuppressWarnings("unchecked")
-                final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> submoduleCtx =
-                        (Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>) ctx
-                        .getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
+            for (final StmtContext<?, ?, ?> submoduleCtx : includedSubmodules) {
                 final SubmoduleEffectiveStatementImpl submodule = (SubmoduleEffectiveStatementImpl) submoduleCtx
                         .buildEffective();
                 submodulesInit.add(submodule);
@@ -158,10 +157,9 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
              */
             final Set<StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>>
                 submoduleContextsInit = new HashSet<>();
-            for (final ModuleIdentifier submoduleIdentifier : includedSubmodulesMap.values()) {
-                final StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> submoduleCtx =
-                        ctx.getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
-                submoduleContextsInit.add(submoduleCtx);
+            for (final StmtContext<?, ?, ?> submoduleCtx : includedSubmodulesMap.values()) {
+                submoduleContextsInit.add(
+                    (StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>)submoduleCtx);
             }
 
             this.submoduleContextsToBuild = ImmutableSet.copyOf(submoduleContextsInit);
@@ -181,7 +179,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
         effectiveSubstatements.addAll(substatementsOfSubmodules);
 
         final List<UnknownSchemaNode> unknownNodesInit = new ArrayList<>();
-        final Set<AugmentationSchema> augmentationsInit = new LinkedHashSet<>();
+        final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
         final Set<ModuleImport> importsInit = new HashSet<>();
         final Set<NotificationDefinition> notificationsInit = new HashSet<>();
         final Set<RpcDefinition> rpcsInit = new HashSet<>();
@@ -200,8 +198,8 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
             if (effectiveStatement instanceof UnknownSchemaNode) {
                 unknownNodesInit.add((UnknownSchemaNode) effectiveStatement);
             }
-            if (effectiveStatement instanceof AugmentationSchema) {
-                augmentationsInit.add((AugmentationSchema) effectiveStatement);
+            if (effectiveStatement instanceof AugmentationSchemaNode) {
+                augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
             }
             if (effectiveStatement instanceof ModuleImport) {
                 importsInit.add((ModuleImport) effectiveStatement);
@@ -289,7 +287,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public Date getRevision() {
+    public Optional<Revision> getRevision() {
         return getQNameModule().getRevision();
     }
 
@@ -304,13 +302,13 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public String getOrganization() {
-        return organization;
+    public Optional<String> getOrganization() {
+        return Optional.ofNullable(organization);
     }
 
     @Override
-    public String getContact() {
-        return contact;
+    public Optional<String> getContact() {
+        return Optional.ofNullable(contact);
     }
 
     @Override
@@ -320,8 +318,8 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
 
     @Override
     public Set<Module> getSubmodules() {
-        Preconditions.checkState(sealed,
-            "Attempt to get base submodules from unsealed submodule effective statement %s", getQNameModule());
+        checkState(sealed, "Attempt to get base submodules from unsealed submodule effective statement %s",
+            getQNameModule());
         return submodules;
     }
 
@@ -336,7 +334,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public Set<AugmentationSchema> getAugmentations() {
+    public Set<AugmentationSchemaNode> getAugmentations() {
         return augmentations;
     }
 
@@ -382,10 +380,9 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public final DataSchemaNode getDataChildByName(final QName name) {
-        // Child nodes are keyed by their container name, so we can do a direct
-        // lookup
-        return childNodes.get(name);
+    public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
+        // Child nodes are keyed by their container name, so we can do a direct lookup
+        return Optional.ofNullable(childNodes.get(requireNonNull(name)));
     }
 
     @Override
@@ -394,19 +391,19 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public SemVer getSemanticVersion() {
-        return semanticVersion;
+    public Optional<SemVer> getSemanticVersion() {
+        return Optional.ofNullable(semanticVersion);
     }
 
     @Override
     public String toString() {
-        return this.getClass().getSimpleName() + "["
-                + "name=" + name
-                + ", namespace=" + getNamespace()
-                + ", revision=" + getQNameModule().getFormattedRevision()
-                + ", prefix=" + prefix
-                + ", yangVersion=" + yangVersion
-                + "]";
+        return MoreObjects.toStringHelper(this).omitNullValues()
+                .add("name", name)
+                .add("namespace", getNamespace())
+                .add("revision", getRevision().orElse(null))
+                .add("prefix", prefix)
+                .add("yangVersion", yangVersion)
+                .toString();
     }
 
     @Override