Propagate EffectiveModelContext to more places

[yangtools.git] / yang / yang-parser-api / src / main / java / org / opendaylight / yangtools / yang / model / parser / api / YangParser.java

diff --git a/yang/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/model/parser/api/YangParser.java b/yang/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/model/parser/api/YangParser.java
index 21909fd3cfdf67766dc2894c72f26af6478452de..805efb6037fa7bdd02a51a8de77cbda94cf17daf 100644 (file)
--- a/yang/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/model/parser/api/YangParser.java
+++ b/yang/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/model/parser/api/YangParser.java
@@ -12,25 +12,22 @@ import com.google.common.collect.SetMultimap;
 import java.io.IOException;
 import java.util.Collection;
 import java.util.List;
-import java.util.Map;
 import java.util.Set;
-import javax.annotation.concurrent.NotThreadSafe;
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
 
 /**
  * Configurable single-use YANG parser. Each instance can be configured to use a different set of models after
- * which it is built. Models once added cannot be removed.
+ * which it is built. Models once added cannot be removed. Implementations are expected to be NOT thread-safe.
  *
  * @author Robert Varga
  */
 @Beta
-@NotThreadSafe
 public interface YangParser {
     /**
      * Return enumeration of concrete types of {@link SchemaSourceRepresentation} parsers created from this factory
@@ -39,14 +36,14 @@ public interface YangParser {
      *
      * @return Enumeration of supported schema source representations.
      */
-    Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
+    @NonNull Collection<Class<? extends SchemaSourceRepresentation>> supportedSourceRepresentations();
 
     /**
      * Return the set of all YANG statements semantically supported by this parser instance.
      *
      * @return Set of all YANG statements semantically supported by this parser instance.
      */
-    Set<QName> supportedStatements();
+    @NonNull Set<QName> supportedStatements();
 
     /**
      * Add main source. All main sources are present in resulting SchemaContext.
@@ -56,7 +53,7 @@ public interface YangParser {
      * @throws IOException when an IO error occurs
      * @throws IllegalArgumentException if the representation is not supported
      */
-    YangParser addSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
+    @NonNull YangParser addSource(SchemaSourceRepresentation source) throws IOException, YangSyntaxErrorException;
 
     /**
      * Add main sources. All main sources are present in resulting SchemaContext.
@@ -66,7 +63,7 @@ public interface YangParser {
      * @throws IOException when an IO error occurs
      * @throws IllegalArgumentException if the representation is not supported
      */
-    default YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
+    default @NonNull YangParser addSources(final SchemaSourceRepresentation... sources) throws IOException,
         YangSyntaxErrorException {
         for (SchemaSourceRepresentation source : sources) {
             addSource(source);
@@ -74,8 +71,8 @@ public interface YangParser {
         return this;
     }
 
-    default YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources) throws IOException,
-        YangSyntaxErrorException {
+    default @NonNull YangParser addSources(final Collection<? extends SchemaSourceRepresentation> sources)
+            throws IOException, YangSyntaxErrorException {
         for (SchemaSourceRepresentation source : sources) {
             addSource(source);
         }
@@ -96,7 +93,7 @@ public interface YangParser {
      * @throws IOException when an IO error occurs
      * @throws IllegalArgumentException if the representation is not supported
      */
-    default YangParser addLibSources(final SchemaSourceRepresentation... sources) throws IOException,
+    default @NonNull YangParser addLibSources(final SchemaSourceRepresentation... sources) throws IOException,
             YangSyntaxErrorException {
         for (SchemaSourceRepresentation source : sources) {
             addLibSource(source);
@@ -104,7 +101,7 @@ public interface YangParser {
         return this;
     }
 
-    default YangParser addLibSources(final Collection<SchemaSourceRepresentation> sources) throws IOException,
+    default @NonNull YangParser addLibSources(final Collection<SchemaSourceRepresentation> sources) throws IOException,
             YangSyntaxErrorException {
         for (SchemaSourceRepresentation source : sources) {
             addLibSource(source);
@@ -119,7 +116,7 @@ public interface YangParser {
      * @param supportedFeatures Set of supported features in the final SchemaContext. If the set is empty, no features
      *                          encountered will be supported.
      */
-    YangParser setSupportedFeatures(@NonNull Set<QName> supportedFeatures);
+    @NonNull YangParser setSupportedFeatures(@NonNull Set<QName> supportedFeatures);
 
     /**
      * Set YANG modules which can be deviated by specified modules during the parsing process. Map key (QNameModule)
@@ -129,7 +126,7 @@ public interface YangParser {
      *                                 value) in the final SchemaContext. If the map is empty, no deviations encountered
      *                                 will be supported.
      */
-    YangParser setModulesWithSupportedDeviations(
+    @NonNull YangParser setModulesWithSupportedDeviations(
             @NonNull SetMultimap<QNameModule, QNameModule> modulesDeviatedByModules);
 
     /**
@@ -138,7 +135,7 @@ public interface YangParser {
      * @return Ordered collection of declared statements from requested sources.
      * @throws YangSyntaxErrorException When a syntactic error is encountered.
      */
-    List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
+    @NonNull List<DeclaredStatement<?>> buildDeclaredModel() throws YangParserException;
 
     /**
      * Build the effective view of a combined view of effective statements. Note that this representation, unlike
@@ -148,16 +145,17 @@ public interface YangParser {
      * @return Effective module statements indexed by their QNameModule.
      * @throws YangSyntaxErrorException When a syntactic error is encountered.
      */
-    // FIXME: 3.0.0: Make this method non-default
-    default Map<QNameModule, ModuleEffectiveStatement> buildEffectiveModel() throws YangParserException {
-        throw new UnsupportedOperationException(getClass() + " does not implement buildEffectiveModel()");
-    }
+    @NonNull EffectiveModelContext buildEffectiveModel() throws YangParserException;
 
     /**
      * Build effective {@link SchemaContext}.
      *
      * @return An effective schema context comprised of configured models.
      * @throws YangSyntaxErrorException When a syntactic error is encountered.
+     * @deprecated Use {@link #buildEffectiveModel()} instead.
      */
-    SchemaContext buildSchemaContext() throws YangParserException;
+    @Deprecated(forRemoval = true)
+    default @NonNull SchemaContext buildSchemaContext() throws YangParserException {
+        return buildEffectiveModel();
+    }
 }