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

Class GeneratedPropertyBuilderImpl

java.lang.Object

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

All Implemented Interfaces:

AnnotableTypeBuilder, GeneratedPropertyBuilder, TypeMemberBuilder<GeneratedPropertyBuilder>

public final class GeneratedPropertyBuilderImpl
extends Object
implements GeneratedPropertyBuilder

Constructor Summary

Constructors

Constructor and Description
GeneratedPropertyBuilderImpl(String name)

Method Summary

Modifier and Type	Method and Description
AnnotationTypeBuilder	addAnnotation(JavaTypeName identifier) The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
boolean	equals(Object obj)
AccessModifier	getAccessModifier()
protected Iterable<AnnotationTypeBuilder>	getAnnotationBuilders()
protected String	getComment()
String	getName() Returns the name of property.
Type	getReturnType()
int	hashCode()
protected boolean	isFinal()
protected boolean	isStatic()
T	setAccessModifier(AccessModifier modifier) Sets the access modifier of property.
T	setComment(String newComment) Adds String definition of comment into Method Signature definition.
T	setFinal(boolean newIsFinal) Sets the flag final for method signature.
GeneratedPropertyBuilderImpl	setReadOnly(boolean isReadOnly) Sets isReadOnly flag for property.
T	setReturnType(Type newReturnType) Adds return Type into Builder definition for Generated Property.
T	setStatic(boolean newIsStatic)
GeneratedPropertyBuilderImpl	setValue(String value)
protected GeneratedPropertyBuilderImpl	thisInstance()
protected List<AnnotationType>	toAnnotationTypes()
GeneratedProperty	toInstance(Type definingType) Returns new immutable instance of Generated Property.
String	toString()

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

getAccessModifier, getName, setAccessModifier, setComment, setFinal, setReturnType, setStatic

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

addAnnotation, addAnnotation

Constructor Detail

GeneratedPropertyBuilderImpl

public GeneratedPropertyBuilderImpl(String name)

Method Detail

setValue

public GeneratedPropertyBuilderImpl setValue(String value)

Specified by:

setValue in interface GeneratedPropertyBuilder

setReadOnly

public GeneratedPropertyBuilderImpl setReadOnly(boolean isReadOnly)

Description copied from interface: GeneratedPropertyBuilder

Sets isReadOnly flag for property. If property is marked as read only it is the same as set property in Java as final.

Specified by:

setReadOnly in interface GeneratedPropertyBuilder

Parameters:

isReadOnly - Read Only property flag.

thisInstance

protected GeneratedPropertyBuilderImpl thisInstance()

toInstance

public GeneratedProperty toInstance(Type definingType)

Description copied from interface: GeneratedPropertyBuilder

Returns new immutable instance of Generated Property.
The definingType param cannot be null. The every member in Java MUST be declared and defined inside the scope of class definition. In case that defining Type will be passed as null reference the method SHOULD thrown IllegalArgumentException.

Specified by:

toInstance in interface GeneratedPropertyBuilder

Parameters:

definingType - Defining Type of Generated Property

Returns:

new immutable instance of Generated Property.

toString

public String toString()

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.

getReturnType

public Type getReturnType()

getAnnotationBuilders

protected Iterable<AnnotationTypeBuilder> getAnnotationBuilders()

getComment

protected String getComment()

isFinal

protected boolean isFinal()

isStatic

protected boolean isStatic()

getAccessModifier

public AccessModifier getAccessModifier()

Specified by:

getAccessModifier in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

getName

public String getName()

Description copied from interface: TypeMemberBuilder

Returns the name of property.

Specified by:

getName in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

Returns:

the name of property.

setReturnType

public T setReturnType(Type newReturnType)

Description copied from interface: TypeMemberBuilder

Adds return Type into Builder definition for Generated Property. The return Type MUST NOT be null, otherwise the method SHOULD throw IllegalArgumentException

Specified by:

setReturnType in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

Parameters:

newReturnType - Return Type of property.

setAccessModifier

public T setAccessModifier(AccessModifier modifier)

Description copied from interface: TypeMemberBuilder

Sets the access modifier of property.

Specified by:

setAccessModifier in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

Parameters:

modifier - Access Modifier value.

setComment

public T setComment(String newComment)

Description copied from interface: TypeMemberBuilder

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:

setComment in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

Parameters:

newComment - Comment String.

setFinal

public T setFinal(boolean newIsFinal)

Description copied from interface: TypeMemberBuilder

Sets the flag final for method signature. If this is set the method will be prohibited from overriding. This setting is irrelevant for methods designated to be defined in interface definitions because interfaces cannot have a final method.

Specified by:

setFinal in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

Parameters:

newIsFinal - Is Final

setStatic

public T setStatic(boolean newIsStatic)

Specified by:

setStatic in interface TypeMemberBuilder<T extends TypeMemberBuilder<T>>

toAnnotationTypes

protected List<AnnotationType> toAnnotationTypes()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object