Cleanup checkstyle in yang-{data,model}-api

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java
index 5d5d2da8e4af2a6cdfa1e20e9fb73930e02e8151..a91dd7eeb489cc7dcacce078e473e4657864c27a 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/StatementDefinition.java
@@ -13,24 +13,19 @@ import org.opendaylight.yangtools.concepts.Immutable;
 import org.opendaylight.yangtools.yang.common.QName;
 
 /**
- *
  * Definition / model of YANG {@link DeclaredStatement} and {@link EffectiveStatement}.
  *
- * Statement concept is defined in RFC6020 section 6.3:
- * <blockquote> A YANG
+ * <p>
+ * Statement concept is defined in RFC6020 section 6.3: <blockquote> A YANG
  * module contains a sequence of statements. Each statement starts with a
- * keyword, followed by zero or one argument
- * </blockquote>
+ * keyword, followed by zero or one argument </blockquote>
  *
+ * <p>
  * Source: <a href="https://tools.ietf.org/html/rfc6020#section-6.3"> </a>
- *
- *
  */
 public interface StatementDefinition extends Immutable {
-
     /**
-     *
-     * Returns name of the statement
+     * Returns name of the statement.
      *
      * @return Name of the statement
      */
@@ -38,7 +33,6 @@ public interface StatementDefinition extends Immutable {
     QName getStatementName();
 
     /**
-     *
      * Returns name of statement argument or null, if statement does not have
      * argument.
      *
@@ -48,10 +42,10 @@ public interface StatementDefinition extends Immutable {
     QName getArgumentName();
 
     /**
-     *
      * Returns class which represents declared version of statement associated
      * with this definition.
      *
+     * <p>
      * This class should be interface, which provides convenience access to
      * declared substatements.
      *
@@ -62,16 +56,25 @@ public interface StatementDefinition extends Immutable {
     Class<? extends DeclaredStatement<?>> getDeclaredRepresentationClass();
 
     /**
+     * Returns class which represents derived behaviour from supplied statement.
      *
-     * Returns class which represents supplied statement.
-     *
+     * <p>
      * This class should be interface, which defines convenience access to
      * statement properties, namespace items and substatements.
      *
-     * @return class which represents declared version of statement associated
+     * @return class which represents effective version of statement associated
      *         with this definition
      */
     @Nonnull
-    Class<? extends DeclaredStatement<?>> getEffectiveRepresentationClass();
+    Class<? extends EffectiveStatement<?, ?>> getEffectiveRepresentationClass();
 
+    /**
+     * Returns true, if argument of statement is represented as value of yin
+     * element. If argument of statement is represented as argument of yin
+     * element, returns false.
+     *
+     * @return returns true, if statement argument is represented as value of
+     *         yin element, otherwise returns false.
+     */
+    boolean isArgumentYinElement();
 }