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 / type / builder / GeneratedTOBuilder.java

diff --git a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/type/builder/GeneratedTOBuilder.java b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/type/builder/GeneratedTOBuilder.java
index fc3495e184565f052f5b8a21a3f6577f1bac5e0f..8d36ad6c4635039798848e4dc5fdb1b27bb09be6 100644 (file)
--- a/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/type/builder/GeneratedTOBuilder.java
+++ b/opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/type/builder/GeneratedTOBuilder.java
@@ -10,23 +10,77 @@ package org.opendaylight.controller.sal.binding.model.api.type.builder;
 import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject;
 
 /**
-
+ * Generated Transfer Object Builder is interface that contains methods to
+ * build and instantiate Generated Transfer Object definition.
+ *
+ * @see GeneratedTransferObject
  */
 public interface GeneratedTOBuilder extends GeneratedTypeBuilder {
 
-    public boolean addExtendsType(final GeneratedTransferObject genTransObj);
+    /**
+     * Add Generated Transfer Object from which will be extended current
+     * Generated Transfer Object.
+     * <br>
+     * By definition Java does not allow multiple
+     * inheritance, hence if there is already definition of Generated
+     * Transfer Object the extending object will be overwritten by lastly
+     * added Generated Transfer Object.
+     * <br>
+     * If Generated Transfer Object is <code>null</code> the method SHOULD
+     * throw {@link IllegalArgumentException}
+     *
+     * @param genTransObj Generated Transfer Object
+     */
+    public void setExtendsType(final GeneratedTransferObject genTransObj);
 
+    /**
+     * Add new Generated Property definition for Generated Transfer Object
+     * Builder and returns Generated Property Builder for specifying Property.
+     * <br>
+     * Name of Property cannot be <code>null</code>,
+     * if it is <code>null</code> the method SHOULD throw {@link IllegalArgumentException}
+     *
+     * @param name Name of Property
+     * @return <code>new</code> instance of Generated Property Builder.
+     */
     public GeneratedPropertyBuilder addProperty(final String name);
 
+    /**
+     * Add Property that will be part of <code>equals</code> definition.
+     * <br>
+     * If Generated Property Builder is <code>null</code> the method SHOULD
+     * throw {@link IllegalArgumentException}
+     *
+     * @param property Generated Property Builder
+     * @return <code>true</code> if addition of Generated Property into list
+     * of <code>equals</code> properties is successful.
+     */
     public boolean addEqualsIdentity(final GeneratedPropertyBuilder property);
 
+    /**
+     * Add Property that will be part of <code>hashCode</code> definition.
+     * <br>
+     * If Generated Property Builder is <code>null</code> the method SHOULD
+     * throw {@link IllegalArgumentException}
+     *
+     * @param property Generated Property Builder
+     * @return <code>true</code> if addition of Generated Property into list
+     * of <code>hashCode</code> properties is successful.
+     */
     public boolean addHashIdentity(final GeneratedPropertyBuilder property);
 
+    /**
+     * Add Property that will be part of <code>toString</code> definition.
+     * <br>
+     * If Generated Property Builder is <code>null</code> the method SHOULD
+     * throw {@link IllegalArgumentException}
+     *
+     * @param property Generated Property Builder
+     * @return <code>true</code> if addition of Generated Property into list
+     * of <code>toString</code> properties is successful.
+     */
     public boolean addToStringProperty(final GeneratedPropertyBuilder property);
 
     @Override
     public GeneratedTransferObject toInstance();
-
-    public GeneratedTransferObject toIdentityInstance();
-
 }