Fixing sonar issues 4

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaNode.java
index 53c025c6e50d4de6a06beebf7b2b8b0c6a27e70b..146da3ae65ef5e9c53300d97cd1348473c4aa26e 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaNode.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaNode.java
@@ -1,44 +1,71 @@
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.yang.model.api;\r
-\r
-import java.util.List;\r
-\r
-import org.opendaylight.yangtools.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
+/*
+ * Copyright (c) 2013 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 java.util.List;
+
+import org.opendaylight.yangtools.yang.common.QName;
+
+/**
+ * SchemaNode represents a node in schema tree.
+ */
+public interface SchemaNode {
+
+    /**
+     * Returns QName of the instance of the type <code>SchemaNode</code>.
+     * 
+     * @return QName with the name of the schema node
+     */
+    QName getQName();
+
+    /**
+     * Returns the schema path of the instance of the type
+     * <code>SchemaNode</code> <code>SchemaNode</code>.
+     * 
+     * @return schema path of the schema node
+     */
+    SchemaPath getPath();
+
+    /**
+     * Returns description of the instance of the type <code>SchemaNode</code>
+     * 
+     * @return string with textual description the node which represents the
+     *         argument of the YANG <code>description</code> substatement
+     */
+    String getDescription();
+
+    /**
+     * Returns reference of the instance of the type <code>SchemaNode</code>
+     * 
+     * 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
+     */
+    String getReference();
+
+    /**
+     * 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
+     */
+    Status getStatus();
+
+    /**
+     * 
+     * Returns unknown schema nodes which belongs to this instance of the type
+     * <code>SchemaNode</code>.
+     * 
+     * @return list of unknown schema nodes defined under this schema node.
+     */
+    List<UnknownSchemaNode> getUnknownSchemaNodes();
+
+}