org.opendaylight.mdsal.binding.model.util.generated.type.builder

Class CodegenGeneratedTypeBuilder

java.lang.Object

org.opendaylight.mdsal.binding.model.util.AbstractBaseType

org.opendaylight.mdsal.binding.model.util.generated.type.builder.CodegenGeneratedTypeBuilder

All Implemented Interfaces:

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

public final class CodegenGeneratedTypeBuilder
extends AbstractBaseType
implements GeneratedTypeBuilder

Constructor Summary

Constructors

Constructor and Description
CodegenGeneratedTypeBuilder(JavaTypeName identifier)

Method Summary

Modifier and Type	Method and Description
AnnotationTypeBuilder	addAnnotation(JavaTypeName identifier) The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
T	addComment(TypeComment newComment) Adds String definition of comment into Method Signature definition. The comment String MUST NOT contain any comment specific chars (i.e.
Constant	addConstant(Type type, String name, Object value) Adds Constant definition and returns new Constant instance. By definition Constant MUST be defined by return Type, Name and assigned value.
T	addEnclosingTransferObject(GeneratedTOBuilder genTOBuilder) Adds new Enclosing Transfer Object genTOBuilder into definition of Generated Type.
GeneratedTOBuilder	addEnclosingTransferObject(String name) 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.
EnumBuilder	addEnumeration(String name) 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.
T	addImplementsType(Type genType) Add Type to implements.
MethodSignatureBuilder	addMethod(String name) Add new Method Signature definition for Generated Type Builder and returns Method Signature Builder 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)}
GeneratedPropertyBuilder	addProperty(String name) 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.
GeneratedType	build() Returns the new immutable instance of Generated Type.
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()
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()
List<GeneratedPropertyBuilder>	getProperties()
Optional<YangSourceDefinition>	getYangSourceDefinition() Returns the YANG definition of this type, if available.
int	hashCode()
boolean	isAbstract()
T	setAbstract(boolean newIsAbstract) Sets the abstract flag to define Generated Type as abstract type.
void	setDescription(String description) Set a string that contains a human-readable textual description of type definition.
void	setModuleName(String moduleName) Set the name of the module, in which generated type was specified.
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	setSchemaPath(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath) Schema path in schema tree from actual concrete type to the root.
void	setYangSourceDefinition(YangSourceDefinition definition) Set the YANG source definition.
protected CodegenGeneratedTypeBuilder	thisInstance()
String	toString()

Methods inherited from class org.opendaylight.mdsal.binding.model.util.AbstractBaseType

getIdentifier

Methods inherited from class java.lang.Object

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

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, 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

Constructor Detail

CodegenGeneratedTypeBuilder

public CodegenGeneratedTypeBuilder(JavaTypeName identifier)

Method Detail

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<GeneratedTypeBuilder>

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<GeneratedTypeBuilder>

Parameters:

moduleName - the name of the module

setSchemaPath

public void setSchemaPath(org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

Description copied from interface: GeneratedTypeBuilderBase

Schema path in schema tree from actual concrete type to the root.

Specified by:

setSchemaPath in interface GeneratedTypeBuilderBase<GeneratedTypeBuilder>

Parameters:

schemaPath - 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<GeneratedTypeBuilder>

Parameters:

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

toString

public String toString()

Overrides:

toString in class AbstractBaseType

build

public GeneratedType build()

Description copied from interface: GeneratedTypeBuilder

Returns the new immutable instance of Generated Type.

Specified by:

build in interface GeneratedTypeBuilder

Specified by:

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

Returns:

the new immutable instance of Generated Type.

thisInstance

protected CodegenGeneratedTypeBuilder thisInstance()

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 newComment)

Description copied from interface: GeneratedTypeBuilderBase

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

Specified by:

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

Parameters:

newComment - Comment String.

addAnnotation

public AnnotationTypeBuilder addAnnotation(JavaTypeName identifier)

Description copied from interface: AnnotableTypeBuilder

The method creates new AnnotationTypeBuilder containing specified package name an annotation name.

Specified by:

addAnnotation in interface AnnotableTypeBuilder

Parameters:

identifier - JavaTypeName of the annotation

Returns:

a new instance of Annotation Type Builder.

setAbstract

public T setAbstract(boolean newIsAbstract)

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:

newIsAbstract - 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.

containsConstant

public boolean containsConstant(String name)

addEnumeration

public EnumBuilder addEnumeration(String name)

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.

addMethod

public MethodSignatureBuilder addMethod(String name)

Description copied from interface: GeneratedTypeBuilderBase

Add new Method Signature definition for Generated Type Builder and returns Method Signature Builder 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<T extends GeneratedTypeBuilderBase<T>>

Parameters:

name - Name of Method

Returns:

new instance of Method Signature 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 existence is checked

Returns:

true if property name exists in list of properties.

getParent

public Type getParent()

getProperties

public List<GeneratedPropertyBuilder> getProperties()

Specified by:

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

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