org.opendaylight.mdsal.binding.java.api.generator

Class BuilderTemplate

java.lang.Object

org.opendaylight.mdsal.binding.java.api.generator.BaseTemplate

org.opendaylight.mdsal.binding.java.api.generator.AbstractBuilderTemplate

org.opendaylight.mdsal.binding.java.api.generator.BuilderTemplate

public class BuilderTemplate
extends AbstractBuilderTemplate

Template for generating JAVA builder classes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILDER Constant used as suffix for builder name.

Fields inherited from class org.opendaylight.mdsal.binding.java.api.generator.AbstractBuilderTemplate

augmentType, keyType, properties, targetType

Constructor Summary

Constructors

Constructor and Description
BuilderTemplate(GeneratedType genType, GeneratedType targetType, Set<GeneratedProperty> properties, Type augmentType, Type keyType) Constructs new instance of this class.

Method Summary

Modifier and Type	Method and Description
CharSequence	body() Template method which generates JAVA class body for builder class and for IMPL class.
protected String	formatDataForJavaDoc(GeneratedType type)
protected CharSequence	generateCopyAugmentation(Type implType)
protected CharSequence	generateCopyKeys(List<GeneratedProperty> keyProps)
boolean	hasImplementsFromUses(GeneratedType type) Method is used to find out if given type implements any interface from uses.
boolean	isLocalInnerClass(JavaTypeName name)

Methods inherited from class org.opendaylight.mdsal.binding.java.api.generator.AbstractBuilderTemplate

generateAugmentField, generateCopyConstructor, generateFields, generateGetters, generateToString

Methods inherited from class org.opendaylight.mdsal.binding.java.api.generator.BaseTemplate

asArguments, asArgumentsDeclaration, asCode, asJavadoc, asLink, checkArgument, emitConstant, encodeJavadocSymbols, fieldName, formatDataForJavaDoc, formatDataForJavaDoc, formatToParagraph, generate, generateCheckers, generateParameters, getterMethod, getterMethodName, isAccessor, propertyNameFromGetter, setterMethod, wrapToDocumentation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUILDER

public static final String BUILDER

Constant used as suffix for builder name.

See Also:

Constant Field Values

Constructor Detail

BuilderTemplate

public BuilderTemplate(GeneratedType genType,
                       GeneratedType targetType,
                       Set<GeneratedProperty> properties,
                       Type augmentType,
                       Type keyType)

Constructs new instance of this class.

Throws:

IllegalArgumentException - if genType equals null

Method Detail

isLocalInnerClass

public boolean isLocalInnerClass(JavaTypeName name)

body

public CharSequence body()

Template method which generates JAVA class body for builder class and for IMPL class.

Specified by:

body in class BaseTemplate

Returns:

string with JAVA source code

hasImplementsFromUses

public boolean hasImplementsFromUses(GeneratedType type)

Method is used to find out if given type implements any interface from uses.

formatDataForJavaDoc

protected String formatDataForJavaDoc(GeneratedType type)

Overrides:

formatDataForJavaDoc in class BaseTemplate

generateCopyKeys

protected CharSequence generateCopyKeys(List<GeneratedProperty> keyProps)

Specified by:

generateCopyKeys in class AbstractBuilderTemplate

generateCopyAugmentation

protected CharSequence generateCopyAugmentation(Type implType)

Specified by:

generateCopyAugmentation in class AbstractBuilderTemplate