Bug 6874: [YANG 1.1] Allow "description" and "reference" in "import" and "include"

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java
index bb923b6f3f798e12629f6156d73b5feb7370dee6..a3b031a08cc454e010c80e22038aacd930c43ded 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/DocumentedNode.java
@@ -1,5 +1,17 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 package org.opendaylight.yangtools.yang.model.api;
 
+import com.google.common.collect.ImmutableList;
+import java.util.List;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 /**
  *
  * Node which can have documentation assigned.
@@ -8,30 +20,48 @@ package org.opendaylight.yangtools.yang.model.api;
 public interface DocumentedNode {
 
     /**
-     * Returns description of the instance of the type <code>SchemaNode</code>
+     * All implementations should override this method.
+     * The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of
+     * ModuleImport which do not allow a description statement.
+     * YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a description statement.
      *
-     * @return string with textual description the node which represents the
-     *         argument of the YANG <code>description</code> substatement
+     * @return string that represents the argument of description statement
      */
-    String getDescription();
+    // FIXME: version 2.0.0: make this method non-default
+    @Nullable default String getDescription() {
+        return null;
+    }
 
     /**
-     * Returns reference of the instance of the type <code>SchemaNode</code>
+     * All implementations should override this method.
+     * The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of
+     * ModuleImport which do not allow a reference statement.
+     * YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a reference statement.
      *
-     * The reference refers to external document that provides additional
-     * information relevant for the instance of this type.
-     *
-     * @return string with the reference to some external document which
-     *         represents the argument of the YANG <code>reference</code>
-     *         substatement
+     * @return string that represents the argument of reference statement
      */
-    String getReference();
+    // FIXME: version 2.0.0: make this method non-default
+    @Nullable default String getReference() {
+        return null;
+    }
 
     /**
-     * Returns status of the instance of the type <code>SchemaNode</code>
+     * Returns unknown schema nodes which belongs to this instance.
      *
-     * @return status of this node which represents the argument of the YANG
-     *         <code>status</code> substatement
+     * @return list of unknown schema nodes defined under this node.
      */
-    Status getStatus();
+    default @Nonnull List<UnknownSchemaNode> getUnknownSchemaNodes() {
+        return ImmutableList.of();
+    }
+
+    interface WithStatus extends DocumentedNode {
+
+        /**
+         * Returns status of the instance of the type <code>SchemaNode</code>
+         *
+         * @return status of this node which represents the argument of the YANG
+         *         <code>status</code> substatement
+         */
+        @Nonnull Status getStatus();
+    }
 }