Extended binding-model-api to support of Enclosed Generated Types and TOs.

[controller.git] / opendaylight / sal / yang-prototype / code-generator / binding-model-api / src / main / java / org / opendaylight / controller / sal / binding / model / api / GeneratedType.java

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
index 82d1720714eaeee707a7ebf8b7fe2e809decb653..7a1a8f4f27d948ec5428445e0c61cc5fdfc1bc33 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.java
@@ -16,6 +16,12 @@ import java.util.List;
  * <li><code>interface</code> name (with commentary that <b>SHOULD</b> be
  * present to proper define interface and base <i>contracts</i> specified for
  * interface)</li>
+ * <li>Each Generated Type can define list of types that Generated Type
+ * can implement to extend it's definition (i.e. interface extends list of
+ * interfaces or java class implements list of interfaces)</li>
+ * <li>Each Generated Type can contain multiple enclosed definitions of
+ * Generated Types (i.e. interface can contain N enclosed interface
+ * definitions or enclosed classes)</li>
  * <li><code>enum</code> and <code>constant</code> definitions (i.e. each
  * constant definition is by default defined as <code>public static final</code>
  * + type (either primitive or object) and constant name</li>
@@ -23,40 +29,76 @@ import java.util.List;
  * types) and return values</li>
  * </ul>
  * 
- * By the definition of the interface constant, enum and method definitions MUST
+ * By the definition of the interface constant, enum,
+ * enclosed types and method definitions MUST
  * be public, so there is no need to specify the scope of visibility.
- * 
- * 
  */
 public interface GeneratedType extends Type {
 
+    /**
+     * Returns the parent type if Generated Type is defined as enclosing type,
+     * otherwise returns <code>null</code>
+     *
+     * @return the parent type if Generated Type is defined as enclosing type,
+     * otherwise returns <code>null</code>
+     */
     public Type getParentType();
-    
+
+    /**
+     * Returns comment string associated with Generated Type.
+     *
+     * @return comment string associated with Generated Type.
+     */
     public String getComment();
-    
+
+    /**
+     * Returns List of annotation definitions associated with generated type.
+     *
+     * @return List of annotation definitions associated with generated type.
+     */
     public List<AnnotationType> getAnnotations();
-    
+
+    /**
+     * Returns <code>true</code> if The Generated Type is defined as abstract.
+     *
+     * @return <code>true</code> if The Generated Type is defined as abstract.
+     */
+    public boolean isAbstract();
+
+    /**
+     * Returns List of Types that Generated Type will implement.
+     *
+     * @return List of Types that Generated Type will implement.
+     */
     public List<Type> getImplements();
-    
+
     /**
-     * Returns Set of all Enumerator definitions associated with interface.
-     * 
-     * @return Set of all Enumerator definitions associated with interface.
+     * Returns List of enclosing Generated Types.
+     *
+     * @return List of enclosing Generated Types.
      */
-    public List<Enumeration> getEnumDefintions();
+    public List<GeneratedType> getEnclosedTypes();
 
     /**
+     * Returns List of all Enumerator definitions associated with Generated
+     * Type.
      * 
-     * 
-     * @return
+     * @return List of all Enumerator definitions associated with Generated
+     * Type.
+     */
+    public List<Enumeration> getEnumerations();
+
+    /**
+     * Returns List of Constant definitions associated with Generated Type.
+     *
+     * @return List of Constant definitions associated with Generated Type.
      */
     public List<Constant> getConstantDefinitions();
 
     /**
+     * Returns List of Method Definitions associated with Generated Type.
      * 
-     * 
-     * @return
+     * @return List of Method Definitions associated with Generated Type.
      */
     public List<MethodSignature> getMethodDefinitions();
-
 }