org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder

Class GeneratedTOBuilderImpl

java.lang.Object

org.opendaylight.mdsal.binding.javav2.generator.util.AbstractBaseType

org.opendaylight.mdsal.binding.javav2.generator.util.generated.type.builder.GeneratedTOBuilderImpl

All Implemented Interfaces:

Type, GeneratedTOBuilder, GeneratedTypeBuilderBase<GeneratedTOBuilder>

@Beta
public final class GeneratedTOBuilderImpl
extends AbstractBaseType
implements GeneratedTOBuilder

Field Summary

Fields inherited from class org.opendaylight.mdsal.binding.javav2.generator.util.AbstractBaseType

name, packageName

Constructor Summary

Constructors

Constructor and Description
GeneratedTOBuilderImpl(String packageName, String name, boolean isNormalized)
GeneratedTOBuilderImpl(String packageName, String name, boolean isPkNameNormalized, boolean isTypeNormalized, ModuleContext context)
GeneratedTOBuilderImpl(String packageName, String name, ModuleContext context)

Method Summary

Modifier and Type	Method and Description
AnnotationTypeBuilder	addAnnotation(String packageName, String name) The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
T	addComment(TypeComment typeComment) Adds String definition of comment into Method Signature definition.
Constant	addConstant(Type type, String name, Object value) Adds Constant definition and returns new Constant instance.
T	addEnclosingTransferObject(GeneratedTOBuilder genTOBuilder) Adds new Enclosing Transfer Object genTOBuilder into definition of Generated Type There is no need of specifying of Package Name because enclosing Type is already defined inside Generated Type with specific package name.
GeneratedTOBuilder	addEnclosingTransferObject(String name) Adds new Enclosing Transfer Object into definition of Generated Type and returns new Instance of Generated TO Builder.
EnumBuilder	addEnumeration(String name, ModuleContext context) Adds new Enumeration definition for Generated Type Builder and returns Enum Builder for specifying all Enum parameters.
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.
T	addImplementsType(Type genType) Add Type to implements.
MethodSignatureBuilder	addMethod(String name) Add new MethodSignature definition for GeneratedTypeBuilder and returns MethodSignatureBuilder for specifying all Method parameters.
GeneratedPropertyBuilder	addProperty(String name) Add new Generated Property definition for Generated Transfer Object Builder and returns Generated Property Builder for specifying Property.
GeneratedTOBuilder	addToStringProperty(GeneratedPropertyBuilder property) Add Property that will be part of toString definition.
boolean	containsConstant(String name)
boolean	containsMethod(String name) Checks if GeneratedTypeBuilder contains method with name methodName
boolean	containsProperty(String name) Check whether GeneratedTOBuilder contains property with name name
boolean	equals(Object obj)
protected List<AnnotationTypeBuilder>	getAnnotations()
BindingNamespaceType	getBindingNamespaceType() Get the BindingNamespaceType.
protected TypeComment	getComment()
protected List<Constant>	getConstants()
protected List<GeneratedTOBuilder>	getEnclosedTransferObjects()
protected List<GeneratedTypeBuilder>	getEnclosedTypes()
protected List<EnumBuilder>	getEnumerations()
List<Type>	getImplementsTypes()
List<MethodSignatureBuilder>	getMethodDefinitions()
Type	getParent()
Type	getParentTypeForBuilder() Gets parent type for data schema node builder, the parent MUST be a data tree node.
List<GeneratedPropertyBuilder>	getProperties()
Optional<YangSourceDefinition>	getYangSourceDefinition() Returns the YANG definition of this type, if available.
int	hashCode()
boolean	isAbstract()
T	setAbstract(boolean isabstract) Sets the abstract flag to define Generated Type as abstract type.
void	setBaseType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDef) Sets the base type for Java representation of YANG typedef
void	setBindingNamespaceType(BindingNamespaceType type) Set the BindingNamespaceType.
void	setDescription(String description) Set a string that contains a human-readable textual description of type definition.
GeneratedTOBuilder	setExtendsType(GeneratedTransferObject genTransObj) Add Generated Transfer Object from which will be extended current Generated Transfer Object.
void	setIsUnion(boolean isUnion)
void	setIsUnionBuilder(boolean unionTypeBuilderOrNot)
void	setModuleName(String moduleName) Set the name of the module, in which generated type was specified.
Type	setParentTypeForBuilder(Type type) Sets parent type for data schema node builder, the parent MUST be a data tree node.
void	setReference(String reference) Set a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.
void	setRestrictions(Restrictions restrictions)
void	setSchemaPath(List<org.opendaylight.yangtools.yang.common.QName> schemaPath) Set a list of QNames which represent schema path in schema tree from actual concrete type to the root.
void	setSUID(GeneratedPropertyBuilder suidBuilder)
void	setTypedef(boolean typedefOrNot)
void	setYangSourceDefinition(YangSourceDefinition definition) Set the YANG source definition.
protected GeneratedTOBuilderImpl	thisInstance()
GeneratedTransferObject	toInstance() Returns instance of GeneratedTransferObject which data are build from the data of this builder
String	toString()

Methods inherited from class org.opendaylight.mdsal.binding.javav2.generator.util.AbstractBaseType

getFullyQualifiedName, getName, getPackageName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addAnnotation, addComment, addConstant, addEnclosingTransferObject, addEnclosingTransferObject, addEnumeration, addImplementsType, addProperty, containsMethod, containsProperty, getBindingNamespaceType, getImplementsTypes, getMethodDefinitions, getParentTypeForBuilder, getProperties, getYangSourceDefinition, isAbstract, setAbstract, setBindingNamespaceType, setParentTypeForBuilder, setYangSourceDefinition

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

getFullyQualifiedName, getName, getPackageName

Constructor Detail

GeneratedTOBuilderImpl

public GeneratedTOBuilderImpl(String packageName,
                              String name,
                              ModuleContext context)

GeneratedTOBuilderImpl

public GeneratedTOBuilderImpl(String packageName,
                              String name,
                              boolean isNormalized)

GeneratedTOBuilderImpl

public GeneratedTOBuilderImpl(String packageName,
                              String name,
                              boolean isPkNameNormalized,
                              boolean isTypeNormalized,
                              ModuleContext context)

Method Detail

setExtendsType

public GeneratedTOBuilder setExtendsType(GeneratedTransferObject genTransObj)

Description copied from interface: GeneratedTOBuilder

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 IllegalArgumentException

Specified by:

setExtendsType in interface GeneratedTOBuilder

Parameters:

genTransObj - Generated Transfer Object

Returns:

This instance of builder

addMethod

public MethodSignatureBuilder addMethod(String name)

Add new MethodSignature definition for GeneratedTypeBuilder and returns MethodSignatureBuilder for specifying all Method parameters.
Name of Method cannot be null, if it is null the method SHOULD throw IllegalArgumentException
By Default the MethodSignatureBuilder SHOULD be pre-set as MethodSignatureBuilder.setAbstract(boolean), {TypeMemberBuilder#setFinal(boolean)} and {TypeMemberBuilder#setAccessModifier(boolean)}

Specified by:

addMethod in interface GeneratedTypeBuilderBase<GeneratedTOBuilder>

Parameters:

name - Name of Method

Returns:

new instance of Method Signature Builder.

addEqualsIdentity

public GeneratedTOBuilder addEqualsIdentity(GeneratedPropertyBuilder property)

Description copied from interface: GeneratedTOBuilder

Add Property that will be part of equals definition.
If Generated Property Builder is null the method SHOULD throw IllegalArgumentException

Specified by:

addEqualsIdentity in interface GeneratedTOBuilder

Parameters:

property - Generated Property Builder

Returns:

This instance of builder

addHashIdentity

public GeneratedTOBuilder addHashIdentity(GeneratedPropertyBuilder property)

Description copied from interface: GeneratedTOBuilder

Add Property that will be part of hashCode definition.
If Generated Property Builder is null the method SHOULD throw IllegalArgumentException

Specified by:

addHashIdentity in interface GeneratedTOBuilder

Parameters:

property - Generated Property Builder

Returns:

This instance of builder

addToStringProperty

public GeneratedTOBuilder addToStringProperty(GeneratedPropertyBuilder property)

Description copied from interface: GeneratedTOBuilder

Add Property that will be part of toString definition.
If Generated Property Builder is null the method SHOULD throw IllegalArgumentException

Specified by:

addToStringProperty in interface GeneratedTOBuilder

Parameters:

property - Generated Property Builder

Returns:

This instance of builder

setRestrictions

public void setRestrictions(Restrictions restrictions)

Specified by:

setRestrictions in interface GeneratedTOBuilder

toInstance

public GeneratedTransferObject toInstance()

Description copied from interface: GeneratedTOBuilder

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

Specified by:

toInstance in interface GeneratedTOBuilder

Returns:

generated transfer object instance

setTypedef

public void setTypedef(boolean typedefOrNot)

Specified by:

setTypedef in interface GeneratedTOBuilder

setBaseType

public void setBaseType(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDef)

Description copied from interface: GeneratedTOBuilder

Sets the base type for Java representation of YANG typedef

Specified by:

setBaseType in interface GeneratedTOBuilder

Parameters:

typeDef - Type Definition

setIsUnion

public void setIsUnion(boolean isUnion)

Specified by:

setIsUnion in interface GeneratedTOBuilder

setIsUnionBuilder

public void setIsUnionBuilder(boolean unionTypeBuilderOrNot)

Specified by:

setIsUnionBuilder in interface GeneratedTOBuilder

setSUID

public void setSUID(GeneratedPropertyBuilder suidBuilder)

Specified by:

setSUID in interface GeneratedTOBuilder

setDescription

public void setDescription(String description)

Description copied from interface: GeneratedTypeBuilderBase

Set a string that contains a human-readable textual description of type definition.

Specified by:

setDescription in interface GeneratedTypeBuilderBase<GeneratedTOBuilder>

Parameters:

description - a string that contains a human-readable textual description of type definition.

setModuleName

public void setModuleName(String moduleName)

Description copied from interface: GeneratedTypeBuilderBase

Set the name of the module, in which generated type was specified.

Specified by:

setModuleName in interface GeneratedTypeBuilderBase<GeneratedTOBuilder>

Parameters:

moduleName - the name of the module

setSchemaPath

public void setSchemaPath(List<org.opendaylight.yangtools.yang.common.QName> schemaPath)

Description copied from interface: GeneratedTypeBuilderBase

Set a list of QNames which represent schema path in schema tree from actual concrete type to the root.

Specified by:

setSchemaPath in interface GeneratedTypeBuilderBase<GeneratedTOBuilder>

Parameters:

schemaPath - a list of QNames which represent schema path in schema tree

setReference

public void setReference(String reference)

Description copied from interface: GeneratedTypeBuilderBase

Set a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.

Specified by:

setReference in interface GeneratedTypeBuilderBase<GeneratedTOBuilder>

Parameters:

reference - a textual cross-reference to an external document.

thisInstance

protected GeneratedTOBuilderImpl thisInstance()

toString

public String toString()

Overrides:

toString in class AbstractBaseType

getComment

protected TypeComment getComment()

getAnnotations

protected List<AnnotationTypeBuilder> getAnnotations()

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

getImplementsTypes

public List<Type> getImplementsTypes()

Specified by:

getImplementsTypes in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

getEnumerations

protected List<EnumBuilder> getEnumerations()

getConstants

protected List<Constant> getConstants()

getMethodDefinitions

public List<MethodSignatureBuilder> getMethodDefinitions()

Specified by:

getMethodDefinitions in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

getEnclosedTypes

protected List<GeneratedTypeBuilder> getEnclosedTypes()

getEnclosedTransferObjects

protected List<GeneratedTOBuilder> getEnclosedTransferObjects()

addEnclosingTransferObject

public GeneratedTOBuilder addEnclosingTransferObject(String name)

Description copied from interface: GeneratedTypeBuilderBase

Adds new Enclosing Transfer Object into definition of Generated Type and returns new Instance of Generated TO Builder.
There is no need of specifying of Package Name because enclosing Type is already defined inside Generated Type with specific package name.
The name of enclosing Type cannot be same as Name of parent type and if there is already defined enclosing type with the same name, the new enclosing type will simply overwrite the older definition.
If the name of enclosing type is null the method SHOULD throw IllegalArgumentException

Specified by:

addEnclosingTransferObject in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

name - Name of Enclosing Type

Returns:

new Instance of Generated Type Builder.

addEnclosingTransferObject

public T addEnclosingTransferObject(GeneratedTOBuilder genTOBuilder)

Description copied from interface: GeneratedTypeBuilderBase

Adds new Enclosing Transfer Object genTOBuilder into definition of Generated Type
There is no need of specifying of Package Name because enclosing Type is already defined inside Generated Type with specific package name.
The name of enclosing Type cannot be same as Name of parent type and if there is already defined enclosing type with the same name, the new enclosing type will simply overwrite the older definition.
If the parameter genTOBuilder of enclosing type is null the method SHOULD throw IllegalArgumentException

Specified by:

addEnclosingTransferObject in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

genTOBuilder - Name of Enclosing Type

addComment

public T addComment(TypeComment typeComment)

Description copied from interface: GeneratedTypeBuilderBase

Adds String definition of comment into Method Signature definition.
The comment String MUST NOT contain anny comment specific chars (i.e. "/**" or "//") just plain String text description.

Specified by:

addComment in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

typeComment - Comment String.

addAnnotation

public AnnotationTypeBuilder addAnnotation(String packageName,
                                           String name)

Description copied from interface: GeneratedTypeBuilderBase

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

Specified by:

addAnnotation in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

packageName - Package Name of Annotation Type

name - Name of Annotation Type

Returns:

new instance of Annotation Type Builder.

setAbstract

public T setAbstract(boolean isabstract)

Description copied from interface: GeneratedTypeBuilderBase

Sets the abstract flag to define Generated Type as abstract type.

Specified by:

setAbstract in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

isabstract - abstract flag

addImplementsType

public T addImplementsType(Type genType)

Description copied from interface: GeneratedTypeBuilderBase

Add Type to implements.

Specified by:

addImplementsType in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

genType - Type to implement

Returns:

true if the addition of type is successful.

addConstant

public Constant addConstant(Type type,
                            String name,
                            Object value)

Description copied from interface: GeneratedTypeBuilderBase

Adds Constant definition and returns new Constant instance.
By definition Constant MUST be defined by return Type, Name and assigned value. The name SHOULD be defined with capital letters. Neither of method parameters can be null and the method SHOULD throw IllegalArgumentException if the contract is broken.

Specified by:

addConstant in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

type - Constant Type

name - Name of Constant

value - Assigned Value

Returns:

new Constant instance.

setParentTypeForBuilder

public Type setParentTypeForBuilder(Type type)

Description copied from interface: GeneratedTypeBuilderBase

Sets parent type for data schema node builder, the parent MUST be a data tree node.

Specified by:

setParentTypeForBuilder in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

type - parent generated type of tree node

Returns:

parent generated type

getBindingNamespaceType

public BindingNamespaceType getBindingNamespaceType()

Description copied from interface: GeneratedTypeBuilderBase

Get the BindingNamespaceType.

Specified by:

getBindingNamespaceType in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Returns:

BindingNamespaceType which type belongs to.

setBindingNamespaceType

public void setBindingNamespaceType(BindingNamespaceType type)

Description copied from interface: GeneratedTypeBuilderBase

Set the BindingNamespaceType.

Specified by:

setBindingNamespaceType in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

type - BindingNamespaceType which type belongs to, must not be null

containsConstant

public boolean containsConstant(String name)

addEnumeration

public EnumBuilder addEnumeration(String name,
                                  ModuleContext context)

Description copied from interface: GeneratedTypeBuilderBase

Adds new Enumeration definition for Generated Type Builder and returns Enum Builder for specifying all Enum parameters.
If there is already Enumeration stored with the same name, the old enum will be simply overwritten byt new enum definition.
Name of Enumeration cannot be null, if it is null the method SHOULD throw IllegalArgumentException

Specified by:

addEnumeration in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

name - Enumeration Name

Returns:

new instance of Enumeration Builder.

containsMethod

public boolean containsMethod(String name)

Description copied from interface: GeneratedTypeBuilderBase

Checks if GeneratedTypeBuilder contains method with name methodName

Specified by:

containsMethod in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

name - is method name

addProperty

public GeneratedPropertyBuilder addProperty(String name)

Description copied from interface: GeneratedTypeBuilderBase

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 IllegalArgumentException

Specified by:

addProperty in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

name - Name of Property

Returns:

new instance of Generated Property Builder.

containsProperty

public boolean containsProperty(String name)

Description copied from interface: GeneratedTypeBuilderBase

Check whether GeneratedTOBuilder contains property with name name

Specified by:

containsProperty in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

name - of property which existance is checked

Returns:

true if property name exists in list of properties.

getYangSourceDefinition

public Optional<YangSourceDefinition> getYangSourceDefinition()

Description copied from interface: GeneratedTypeBuilderBase

Returns the YANG definition of this type, if available.

Specified by:

getYangSourceDefinition in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Returns:

YANG source definition, or empty when unavailable.

setYangSourceDefinition

public void setYangSourceDefinition(YangSourceDefinition definition)

Description copied from interface: GeneratedTypeBuilderBase

Set the YANG source definition.

Specified by:

setYangSourceDefinition in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Parameters:

definition - YANG source definition, must not be null

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractBaseType

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractBaseType

getParent

public Type getParent()

getParentTypeForBuilder

public Type getParentTypeForBuilder()

Description copied from interface: GeneratedTypeBuilderBase

Gets parent type for data schema node builder, the parent MUST be a data tree node.

Specified by:

getParentTypeForBuilder in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>

Returns:

parent generated type of tree node

getProperties

public List<GeneratedPropertyBuilder> getProperties()

Specified by:

getProperties in interface GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>>