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

Interface GeneratedTOBuilder

All Superinterfaces:

AnnotableTypeBuilder, org.opendaylight.yangtools.concepts.Builder<GeneratedTransferObject>, org.opendaylight.yangtools.concepts.CheckedBuilder<GeneratedTransferObject,IllegalArgumentException>, GeneratedTypeBuilderBase<GeneratedTOBuilder>, org.opendaylight.yangtools.concepts.Identifiable<JavaTypeName>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>, Type

All Known Implementing Classes:

CodegenGeneratedTOBuilder, RuntimeGeneratedTOBuilder

public interface GeneratedTOBuilder
extends GeneratedTypeBuilderBase<GeneratedTOBuilder>, org.opendaylight.yangtools.concepts.Builder<GeneratedTransferObject>

Generated Transfer Object Builder is interface that contains methods to build and instantiate Generated Transfer Object definition.

See Also:

GeneratedTransferObject

Method Summary

Modifier and Type	Method and Description
GeneratedTOBuilder	addEqualsIdentity(GeneratedPropertyBuilder property) Add Property that will be part of equals definition.
GeneratedTOBuilder	addHashIdentity(GeneratedPropertyBuilder property) Add Property that will be part of hashCode definition.
GeneratedTOBuilder	addToStringProperty(GeneratedPropertyBuilder property) Add Property that will be part of toString definition.
GeneratedTransferObject	build() Returns instance of GeneratedTransferObject which data are build from the data of this builder.
boolean	isUnion()
void	setBaseType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDef) Sets the base type for Java representation of YANG typedef.
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
void	setIsUnion(boolean isUnion) Sets the union flag.
void	setIsUnionBuilder(boolean isUnionTypeBuilder)
void	setRestrictions(Restrictions restrictions)
void	setSUID(GeneratedPropertyBuilder suid)
void	setTypedef(boolean isTypedef)

Methods inherited from interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase

addComment, addConstant, addEnclosingTransferObject, addEnclosingTransferObject, addEnumeration, addImplementsType, addMethod, addProperty, containsMethod, containsProperty, getImplementsTypes, getMethodDefinitions, getProperties, getYangSourceDefinition, isAbstract, setAbstract, setDescription, setModuleName, setReference, setSchemaPath, setYangSourceDefinition

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

getFullyQualifiedName, getName, getPackageName

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

getIdentifier

Methods inherited from interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotableTypeBuilder

addAnnotation, addAnnotation

Method Detail

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

GeneratedTransferObject build()

Returns instance of GeneratedTransferObject which data are build from the data of this builder.

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<GeneratedTransferObject,IllegalArgumentException>

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.

setIsUnionBuilder

void setIsUnionBuilder(boolean isUnionTypeBuilder)

setSUID

void setSUID(GeneratedPropertyBuilder suid)