Minor code refactoring.

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java
index 6e75e98c8ed0445916c286ef47351ba4c1e5759c..8290e22622c88673f64e39158d09c972913baf55 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java
@@ -8,7 +8,7 @@
 package org.opendaylight.yangtools.yang.model.api;
 
 /**
- * 
+ *
  * YANG statement <code>typedef</code> contains also substatements
  * <ul>
  * <li><code>default</code> - default value which is compatible with
@@ -20,7 +20,7 @@ package org.opendaylight.yangtools.yang.model.api;
  * </ul>
  * This interface contains the methods for getting the values of the arguments
  * of substatements mentioned above.
- * 
+ *
  * @param <T>
  *            type of the base type (YANG <code>type</code> substatement) which
  *            is included in the instance of this type
@@ -28,12 +28,12 @@ package org.opendaylight.yangtools.yang.model.api;
 public interface TypeDefinition<T extends TypeDefinition<?>> extends SchemaNode {
 
     /**
-     * Returns the base type which represents the value of the argument of the
-     * <code>type</code> substatement of the YANG <code>typedef</code>
-     * statement.
-     * 
+     * Returns the base type from which this type is derived. If this is yang
+     * built-in type, returns null.
+     *
      * @return value of <code>&lt;T&gt;</code> type which represents the base
-     *         type of instance of the <code>TypeDefinition</code> type
+     *         type of instance of the <code>TypeDefinition</code> type or null,
+     *         if this is yang built-in type
      */
     T getBaseType();
 
@@ -41,7 +41,7 @@ public interface TypeDefinition<T extends TypeDefinition<?>> extends SchemaNode
      * Returns the unit which represents the value of the argument of the
      * <code>units</code> substatement of the YANG <code>typedef</code>
      * statement.
-     * 
+     *
      * @return string with units in which is type measured
      */
     String getUnits();
@@ -50,7 +50,7 @@ public interface TypeDefinition<T extends TypeDefinition<?>> extends SchemaNode
      * Returns the default value which represents the value of the argument of
      * the <code>default</code> substatement of the YANG <code>typedef</code>
      * statement.
-     * 
+     *
      * @return instance of <code>Object</code> type which contains default value
      *         for <code>typedef</code>
      */