X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fsal%2Fyang-prototype%2Fcode-generator%2Fbinding-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fbinding%2Fmodel%2Fapi%2Ftype%2Fbuilder%2FGeneratedTOBuilder.java;h=8d36ad6c4635039798848e4dc5fdb1b27bb09be6;hb=84ca16196357ad899e00eceae27ef75eaf899d14;hp=c01425407d0248e9b38039004cbddef179adb6cc;hpb=1df98168ffe7acd9dd908fde4782dc499c5e2d5a;p=controller.git 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 c01425407d..8d36ad6c46 100644 --- 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,18 +10,75 @@ 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. + *
+ * 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. + *
+ * If Generated Transfer Object is null 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. + *
+ * Name of Property cannot be null, + * if it is null the method SHOULD throw {@link IllegalArgumentException} + * + * @param name Name of Property + * @return new instance of Generated Property Builder. + */ public GeneratedPropertyBuilder addProperty(final String name); + /** + * Add Property that will be part of equals definition. + *
+ * If Generated Property Builder is null the method SHOULD + * throw {@link IllegalArgumentException} + * + * @param property Generated Property Builder + * @return true if addition of Generated Property into list + * of equals properties is successful. + */ public boolean addEqualsIdentity(final GeneratedPropertyBuilder property); + /** + * Add Property that will be part of hashCode definition. + *
+ * If Generated Property Builder is null the method SHOULD + * throw {@link IllegalArgumentException} + * + * @param property Generated Property Builder + * @return true if addition of Generated Property into list + * of hashCode properties is successful. + */ public boolean addHashIdentity(final GeneratedPropertyBuilder property); + /** + * Add Property that will be part of toString definition. + *
+ * If Generated Property Builder is null the method SHOULD + * throw {@link IllegalArgumentException} + * + * @param property Generated Property Builder + * @return true if addition of Generated Property into list + * of toString properties is successful. + */ public boolean addToStringProperty(final GeneratedPropertyBuilder property); @Override