X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=code-generator%2Fbinding-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fsal%2Fbinding%2Fmodel%2Fapi%2Ftype%2Fbuilder%2FAnnotationTypeBuilder.java;h=c9ded321d3b24a4e1261cbb8f7a491417b13bb16;hb=694963e826d61dce6a2568d4b4a8cb7f449d58dc;hp=260bdc24515378e32144efb0e58952e1bd162b45;hpb=906fae19c653e8872ecbaea33f152a13a0a8bf9e;p=yangtools.git diff --git a/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/type/builder/AnnotationTypeBuilder.java b/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/type/builder/AnnotationTypeBuilder.java index 260bdc2451..c9ded321d3 100644 --- a/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/type/builder/AnnotationTypeBuilder.java +++ b/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/type/builder/AnnotationTypeBuilder.java @@ -14,81 +14,76 @@ import org.opendaylight.yangtools.sal.binding.model.api.Type; /** * Annotation Type Builder Interface serves for creation and instantiation of - * immutable copy of Annotation Type. The Annotation Type Builder extends - * from {@link Type} interface. The Annotation Type contains set of methods - * which are capable to provide information about other Annotation Types and - * Annotation Parameters. - * + * immutable copy of Annotation Type. The Annotation Type Builder extends from + * {@link Type} interface. The Annotation Type contains set of methods which are + * capable to provide information about other Annotation Types and Annotation + * Parameters. + * * @see AnnotationType */ public interface AnnotationTypeBuilder extends Type { /** - * The method creates new AnnotationTypeBuilder containing specified - * package name an annotation name. - *
- * Neither the package name or annotation name can contain - * null references. In case that - * any of parameters contains null the method SHOULD thrown - * {@link IllegalArgumentException} - * - * @param packageName Package Name of Annotation Type - * @param name Name of Annotation Type + * The method creates new AnnotationTypeBuilder containing specified package + * name an annotation name.
+ * Neither the package name or annotation name can contain null + * references. In case that any of parameters contains null the + * method SHOULD thrown {@link IllegalArgumentException} + * + * @param packageName + * Package Name of Annotation Type + * @param name + * Name of Annotation Type * @return new instance of Annotation Type Builder. */ - public AnnotationTypeBuilder addAnnotation(final String packageName, final String name); + AnnotationTypeBuilder addAnnotation(final String packageName, final String name); /** - * Adds the parameter into List of parameters for Annotation Type. - *
+ * Adds the parameter into List of parameters for Annotation Type.
* If there is already stored parameter with the same name as the new * parameter, the value of the old one will be simply overwritten by the - * newer parameter. - *
- * Neither the param name or value can contain - * null references. In case that - * any of parameters contains null the method SHOULD thrown - * {@link IllegalArgumentException} - * - * @param paramName Parameter Name - * @param value Parameter Value - * @return true if the parameter has been successfully - * assigned for Annotation Type + * newer parameter.
+ * Neither the param name or value can contain null references. + * In case that any of parameters contains null the method + * SHOULD thrown {@link IllegalArgumentException} + * + * @param paramName + * Parameter Name + * @param value + * Parameter Value + * @return true if the parameter has been successfully assigned + * for Annotation Type */ - public boolean addParameter(final String paramName, String value); + boolean addParameter(final String paramName, String value); /** * Adds the parameter with specified List of parameter values into List of - * parameters for Annotation Type. - *
+ * parameters for Annotation Type.
* If there is already stored parameter with the same name as the new * parameter, the value of the old one will be simply overwritten by the - * newer parameter. - *
- * Neither the param name or value can contain - * null references. In case that - * any of parameters contains null the method SHOULD thrown - * {@link IllegalArgumentException} - * - * @param paramName Parameter Name - * @param values List of Values bounded to Parameter Name - * @return true if the parameter has been successfully - * assigned for Annotation Type + * newer parameter.
+ * Neither the param name or value can contain null references. + * In case that any of parameters contains null the method + * SHOULD thrown {@link IllegalArgumentException} + * + * @param paramName + * Parameter Name + * @param values + * List of Values bounded to Parameter Name + * @return true if the parameter has been successfully assigned + * for Annotation Type */ - public boolean addParameters(final String paramName, List values); + boolean addParameters(final String paramName, List values); /** * Returns new immutable instance of Annotation Type - * with values assigned in current instance of Annotation Type Builder. - *
+ * with values assigned in current instance of Annotation Type Builder.
* The return Annotation Type instance is immutable thus no additional * modification to Annotation Type Builder will have an impact to - * instantiated Annotation Type. - *
- * For this purpose call this method after - * all additions are complete. - * + * instantiated Annotation Type.
+ * For this purpose call this method after all additions are complete. + * * @return new immutable instance of Annotation Type. */ - public AnnotationType toInstance(); + AnnotationType toInstance(); }