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

Class AbstractBuilderTemplate

java.lang.Object

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

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

Direct Known Subclasses:

BuilderImplTemplate, BuilderTemplate

public abstract class AbstractBuilderTemplate
extends BaseTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected Type	augmentType Generated property is set if among methods is found one with the name GET_AUGMENTATION_METHOD_NAME.
protected Type	keyType GeneratedType for key type, null if this type does not have a key.
protected Set<GeneratedProperty>	properties Set of class attributes (fields) which are derived from the getter methods names.
protected GeneratedType	targetType

Constructor Summary

Constructors

Constructor and Description
AbstractBuilderTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType, GeneratedType type, GeneratedType targetType, Set<GeneratedProperty> properties, Type augmentType, Type keyType)
AbstractBuilderTemplate(GeneratedType type, GeneratedType targetType, Set<GeneratedProperty> properties, Type augmentType, Type keyType)

Method Summary

Modifier and Type	Method and Description
protected String	generateAugmentField()
protected abstract CharSequence	generateCopyAugmentation(Type implType)
protected CharSequence	generateCopyConstructor(Type fromType, Type implType)
protected abstract CharSequence	generateCopyKeys(List<GeneratedProperty> keyProps)
protected CharSequence	generateFields(boolean makeFinal) Template method which generates class attributes.
CharSequence	generateGetters(boolean addOverride) Template method which generate getter methods for IMPL class.
CharSequence	generateToString(Collection<GeneratedProperty> properties)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

augmentType

protected final Type augmentType

Generated property is set if among methods is found one with the name GET_AUGMENTATION_METHOD_NAME.

properties

protected final Set<GeneratedProperty> properties

Set of class attributes (fields) which are derived from the getter methods names.

keyType

protected final Type keyType

GeneratedType for key type, null if this type does not have a key.

targetType

protected final GeneratedType targetType

Constructor Detail

AbstractBuilderTemplate

public AbstractBuilderTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType,
                               GeneratedType type,
                               GeneratedType targetType,
                               Set<GeneratedProperty> properties,
                               Type augmentType,
                               Type keyType)

AbstractBuilderTemplate

public AbstractBuilderTemplate(GeneratedType type,
                               GeneratedType targetType,
                               Set<GeneratedProperty> properties,
                               Type augmentType,
                               Type keyType)

Method Detail

generateFields

protected final CharSequence generateFields(boolean makeFinal)

Template method which generates class attributes.

Parameters:

makeFinal - value which specify whether field is|isn't final

Returns:

string with class attributes and their types

generateAugmentField

protected final String generateAugmentField()

generateToString

public CharSequence generateToString(Collection<GeneratedProperty> properties)

Overrides:

generateToString in class BaseTemplate

generateGetters

public final CharSequence generateGetters(boolean addOverride)

Template method which generate getter methods for IMPL class.

Returns:

string with getter methods

generateCopyConstructor

protected final CharSequence generateCopyConstructor(Type fromType,
                                                     Type implType)

generateCopyKeys

protected abstract CharSequence generateCopyKeys(List<GeneratedProperty> keyProps)

generateCopyAugmentation

protected abstract CharSequence generateCopyAugmentation(Type implType)