Fixed tests. Added javadocs to yang-model-api.
[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-api / src / main / java / org / opendaylight / controller / yang / model / api / SchemaNode.java
index 4d3c48654db23dfc6bb7fe53887c002c2bbb03b2..94ccd5dde6d2de1318e4071588fa06a475303f20 100644 (file)
@@ -11,17 +11,34 @@ import java.util.List;
 \r
 import org.opendaylight.controller.yang.common.QName;\r
 \r
+/**\r
+ * SchemaNode represents a node in schema tree.\r
+ */\r
 public interface SchemaNode {\r
 \r
     public QName getQName();\r
 \r
     public SchemaPath getPath();\r
 \r
+    /**\r
+     * @return textual description of this node.\r
+     */\r
     public String getDescription();\r
 \r
+    /**\r
+     * @return textual cross-reference to an external document that provides\r
+     *         additional information relevant to this node.\r
+     */\r
     public String getReference();\r
 \r
+    /**\r
+     * @return actual status of this node.\r
+     */\r
     public Status getStatus();\r
 \r
+    /**\r
+     * @return collection of all unknown nodes defined under this schema node.\r
+     */\r
     public List<UnknownSchemaNode> getUnknownSchemaNodes();\r
+\r
 }\r