Refactor rpc/action statements
[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / ModuleImport.java
index d352aeacbe866dc19ccf71b860d9f8b90f6df112..43976a8a16a2004ea46755602bda70962a1b6c3d 100644 (file)
@@ -7,36 +7,45 @@
  */
 package org.opendaylight.yangtools.yang.model.api;
 
-import java.util.Date;
+import java.util.Optional;
 import org.opendaylight.yangtools.concepts.SemVer;
+import org.opendaylight.yangtools.yang.common.Revision;
 
 /**
  * Interface describing YANG 'import' statement.
+ *
  * <p>
- * The import statement makes definitions from one module available inside
- * another module or submodule.
- * </p>
+ * The import statement makes definitions from one module available inside another module or submodule.
  */
+// FIXME: 5.0.0 this class is a leak of the declared world into the effective one. In effective world, all nodes form
+//        a tree, which consists of multiple (mostly) QName-navigated namespaces. As such module imports contribute
+//        only a prefix/QNameModule mapping to the effective world and hence should be mapped that way:
+//        - Module exposes String->QNameModule mapping
 public interface ModuleImport extends DocumentedNode {
-
     /**
+     * Returns the name of the module to import.
+     *
      * @return Name of the module to import
      */
     String getModuleName();
 
     /**
+     * Returns the module revision to import. May be null.
+     *
      * @return Revision of module to import
      */
-    Date getRevision();
+    Optional<Revision> getRevision();
 
     /**
+     * Returns the semantic version to import.
+     *
      * @return Semantic version of module to import
      */
-    default SemVer getSemanticVersion() {
-        return Module.DEFAULT_SEMANTIC_VERSION;
-    }
+    Optional<SemVer> getSemanticVersion();
 
     /**
+     * Returns the prefix associated with the imported module.
+     *
      * @return Prefix used to point to imported module
      */
     String getPrefix();