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

Interface GeneratedTOBuilder

All Superinterfaces:
AnnotableTypeBuilder, GeneratedTypeBuilderBase<GeneratedTOBuilder>, org.opendaylight.yangtools.concepts.Identifiable<JavaTypeName>, Type
public interface GeneratedTOBuilder extends GeneratedTypeBuilderBase<GeneratedTOBuilder>
Generated Transfer Object Builder is interface that contains methods to build and instantiate Generated Transfer Object definition.
See Also:

  • Method Details

    • setExtendsType

      GeneratedTOBuilder setExtendsType(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 a definition of an 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 IllegalArgumentException
      Parameters:
      genTransObj - Generated Transfer Object
      Returns:
      This instance of builder

    • addEqualsIdentity

      GeneratedTOBuilder addEqualsIdentity(GeneratedPropertyBuilder property)
      Add Property that will be part of equals definition.
      If Generated Property Builder is null the method SHOULD throw IllegalArgumentException
      Parameters:
      property - Generated Property Builder
      Returns:
      This instance of builder

    • addHashIdentity

      GeneratedTOBuilder addHashIdentity(GeneratedPropertyBuilder property)
      Add Property that will be part of hashCode definition.
      If Generated Property Builder is null the method SHOULD throw IllegalArgumentException
      Parameters:
      property - Generated Property Builder
      Returns:
      This instance of builder

    • addToStringProperty

      GeneratedTOBuilder addToStringProperty(GeneratedPropertyBuilder property)
      Add Property that will be part of toString definition.
      If Generated Property Builder is null the method SHOULD throw IllegalArgumentException
      Parameters:
      property - Generated Property Builder
      Returns:
      This instance of builder

    • setRestrictions

      void setRestrictions(Restrictions restrictions)

    • build

      @NonNull GeneratedTransferObject build()
      Returns instance of GeneratedTransferObject which data are build from the data of this builder.
      Returns:
      generated transfer object instance

    • setTypedef

      void setTypedef(boolean isTypedef)

    • setBaseType

      void setBaseType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDef)
      Sets the base type for Java representation of YANG typedef.
      Parameters:
      typeDef - Type Definition

    • isUnion

      boolean isUnion()

    • setIsUnion

      void setIsUnion(boolean isUnion)
      Sets the union flag.
      Parameters:
      isUnion - true if the result is a union type.

    • setSUID

      void setSUID(GeneratedPropertyBuilder suid)