Merge "BUG-1344: Implemented getOriginal() for DataSchemaNode."

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java
index a40bf2bd0ab201e5476ac24043e06bc4bc84d7e8..2bb1d993d9f12dcb2f486aa5064b0129d7177386 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaContext.java
@@ -7,28 +7,123 @@
  */
 package org.opendaylight.yangtools.yang.model.api;
 
+import com.google.common.base.Optional;
+import javax.annotation.concurrent.Immutable;
+import org.opendaylight.yangtools.yang.common.QName;
+
 import java.net.URI;
 import java.util.Date;
 import java.util.Set;
 
-
-
 /**
- * 
+ * The interface represents static view of compiled yang files,
+ * contains the methods for obtaining all the top level context
+ * data (data from all modules) like YANG notifications, extensions,
+ * operations...
+ * Instances MUST be immutable and thus usage in multi threaded
+ * environment is safe.
  */
-public interface SchemaContext {
+@Immutable
+public interface SchemaContext extends ContainerSchemaNode {
 
+    public static final QName NAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), null, "data");
+
+    /**
+     * Returns data schema node instances which represents direct subnodes (like
+     * leaf, leaf-list, list, container) in all YANG modules in the context.
+     *
+     * @return set of <code>DataSchemaNode</code> instances which represents
+     *         YANG data nodes at the module top level
+     */
     Set<DataSchemaNode> getDataDefinitions();
 
+    /**
+     * Returns modules which are part of the schema context.
+     *
+     * @return set of the modules which belong to the schema context
+     */
     Set<Module> getModules();
 
+    /**
+     *
+     * Returns notification definition instances which are defined as the direct
+     * subelements in all YANG modules in the context.
+     *
+     * @return set of <code>NotificationDefinition</code> instances which
+     *         represents nodes defined via <code>notification</code> YANG
+     *         keyword
+     */
     Set<NotificationDefinition> getNotifications();
 
+    /**
+     * Returns rpc definition instances which are defined as the direct
+     * subelements in all YANG modules in the context.
+     *
+     * @return set of <code>RpcDefinition</code> instances which represents
+     *         nodes defined via <code>rpc</code> YANG keyword
+     */
     Set<RpcDefinition> getOperations();
-    
+
+    /**
+     * Returns extencion definition instances which are defined as the direct
+     * subelements in all YANG modules in the context
+     *
+     * @return set of <code>ExtensionDefinition</code> instances which
+     *         represents nodes defined via <code>extension</code> YANG keyword
+     */
     Set<ExtensionDefinition> getExtensions();
-    
+
+    /**
+     * Returns module instance (from the context) with concrete name and
+     * revision date.
+     *
+     * @param name
+     *            string with the module name
+     * @param revision
+     *            date of the module revision
+     * @return module instance which has name and revision (if specified) the
+     *         same as are the values specified in parameters <code>name</code>
+     *         and <code>revision</code>. In other cases the <code>null</code>
+     *         value is returned.
+     *
+     */
     Module findModuleByName(final String name, final Date revision);
-    
-    Module findModuleByNamespace(final URI namespace);
+
+    /**
+     *
+     * Returns module instance (from the context) with concrete namespace.
+     *
+     * @param namespace
+     *            URI instance with specified namespace
+     * @return module instance which has namespace equal to the
+     *         <code>namespace</code> or <code>null</code> in other cases
+     */
+    Set<Module> findModuleByNamespace(final URI namespace);
+
+    /**
+     * Returns module instance based on given namespace and revision. If
+     * revision is not specified, returns module with newest revision.
+     *
+     * @param namespace
+     * @param revision
+     * @return
+     */
+    Module findModuleByNamespaceAndRevision(final URI namespace, final Date revision);
+
+
+    /**
+     * Get yang source code represented as string for matching
+     * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier}.
+     * @param moduleIdentifier must provide a non-null
+     * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier#getName()},
+     * other methods might return null.
+     * @return value iif matching module is found in schema context.
+     */
+    Optional<String> getModuleSource(ModuleIdentifier moduleIdentifier);
+
+    /**
+     * Get all module and submodule identifiers.
+     */
+    Set<ModuleIdentifier> getAllModuleIdentifiers();
+
 }