Module org.opendaylight.mdsal.binding.model.api
Package org.opendaylight.mdsal.binding.model.api.type.builder

Interface AnnotationTypeBuilder

All Superinterfaces:
org.opendaylight.yangtools.concepts.Identifiable<JavaTypeName>, Type
public interface AnnotationTypeBuilder extends Type
Annotation Type Builder Interface serves for creation and instantiation of immutable copy of Annotation Type. The Annotation Type Builder extends from Type interface. The Annotation Type contains set of methods which are capable to provide information about other Annotation Types and Annotation Parameters.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull AnnotationTypeBuilder
    addAnnotation(String packageName, String name)
    The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
    boolean
    addParameter(String paramName, String value)
    Adds the parameter into List of parameters for Annotation Type.
    boolean
    addParameters(String paramName, List<String> values)
    Adds the parameter with specified List of parameter values into List of parameters for Annotation Type.
    @NonNull AnnotationType
    build()
    Returns new immutable instance of Annotation Type with values assigned in current instance of Annotation Type Builder.

    Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

    getIdentifier

    Methods inherited from interface org.opendaylight.mdsal.binding.model.api.Type

    getFullyQualifiedName, getName, getPackageName

  • Method Details

    • addAnnotation

      @NonNull AnnotationTypeBuilder addAnnotation(String packageName, String name)
      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 IllegalArgumentException
      Parameters:
      packageName - Package Name of Annotation Type
      name - Name of Annotation Type
      Returns:
      new instance of Annotation Type Builder.

    • addParameter

      boolean addParameter(String paramName, String value)
      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 IllegalArgumentException
      Parameters:
      paramName - Parameter Name
      value - Parameter Value
      Returns:
      true if the parameter has been successfully assigned for Annotation Type

    • addParameters

      boolean addParameters(String paramName, List<String> values)
      Adds the parameter with specified List of parameter values 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 IllegalArgumentException
      Parameters:
      paramName - Parameter Name
      values - List of Values bounded to Parameter Name
      Returns:
      true if the parameter has been successfully assigned for Annotation Type

    • build

      @NonNull AnnotationType build()
      Returns new immutable instance of Annotation Type 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.
      Returns:
      new immutable instance of Annotation Type.