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

Class BaseTemplate

java.lang.Object

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

Direct Known Subclasses:

AbstractBuilderTemplate, ClassTemplate, EnumTemplate, InterfaceTemplate

public abstract class BaseTemplate
extends Object

Constructor Summary

Constructors

Constructor and Description
BaseTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType, GeneratedType type)
BaseTemplate(GeneratedType type)

Method Summary

Modifier and Type	Method and Description
protected CharSequence	asArguments(Iterable<GeneratedProperty> parameters) Template method which generates sequence of the names of the class attributes from parameters.
protected CharSequence	asArgumentsDeclaration(Iterable<GeneratedProperty> parameters) Template method which generates method parameters with their types from parameters.
String	asCode(String text)
protected CharSequence	asJavadoc(String comment) Template method which generates JAVA comments.
String	asLink(String text)
protected abstract CharSequence	body()
protected CharSequence	checkArgument(GeneratedProperty property, Restrictions restrictions, Type actualType, String value)
protected CharSequence	emitConstant(Constant c)
static String	encodeJavadocSymbols(String description)
protected CharSequence	fieldName(GeneratedProperty property)
protected String	formatDataForJavaDoc(GeneratedType type)
protected String	formatDataForJavaDoc(GeneratedType type, String additionalComment)
protected static String	formatDataForJavaDoc(TypeMember type, String additionalComment)
protected static String	formatToParagraph(String text)
String	generate()
protected CharSequence	generateCheckers(GeneratedProperty field, Restrictions restrictions, Type actualType)
protected CharSequence	generateParameters(List<MethodSignature.Parameter> parameters) Template method which generates method parameters with their types from parameters.
protected CharSequence	generateToString(Collection<GeneratedProperty> properties)
protected CharSequence	getterMethod(GeneratedProperty field) Template method which generates the getter method for field
protected String	getterMethodName(GeneratedProperty field)
protected CharSequence	hashCodeResult(Collection<GeneratedProperty> properties)
protected String	propertyNameFromGetter(MethodSignature getter)
protected CharSequence	setterMethod(GeneratedProperty field) Template method which generates the setter method for field
static String	wrapToDocumentation(String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTemplate

public BaseTemplate(GeneratedType type)

BaseTemplate

public BaseTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType,
                    GeneratedType type)

Method Detail

generate

public final String generate()

body

protected abstract CharSequence body()

fieldName

protected final CharSequence fieldName(GeneratedProperty property)

propertyNameFromGetter

protected final String propertyNameFromGetter(MethodSignature getter)

getterMethod

protected CharSequence getterMethod(GeneratedProperty field)

Template method which generates the getter method for field

Parameters:

field - generated property with data about field which is generated as the getter method

Returns:

string with the getter method source code in JAVA format

getterMethodName

protected final String getterMethodName(GeneratedProperty field)

setterMethod

protected final CharSequence setterMethod(GeneratedProperty field)

Template method which generates the setter method for field

Parameters:

field - generated property with data about field which is generated as the setter method

Returns:

string with the setter method source code in JAVA format

asArgumentsDeclaration

protected final CharSequence asArgumentsDeclaration(Iterable<GeneratedProperty> parameters)

Template method which generates method parameters with their types from parameters.

Parameters:

parameters - group of generated property instances which are transformed to the method parameters

Returns:

string with the list of the method parameters with their types in JAVA format

asArguments

protected final CharSequence asArguments(Iterable<GeneratedProperty> parameters)

Template method which generates sequence of the names of the class attributes from parameters.

Parameters:

parameters - group of generated property instances which are transformed to the sequence of parameter names

Returns:

string with the list of the parameter names of the parameters

asJavadoc

protected CharSequence asJavadoc(String comment)

Template method which generates JAVA comments.

Parameters:

comment - string with the comment for whole JAVA class

Returns:

string with comment in JAVA format

wrapToDocumentation

public static String wrapToDocumentation(String text)

formatDataForJavaDoc

protected String formatDataForJavaDoc(GeneratedType type)

encodeJavadocSymbols

public static String encodeJavadocSymbols(String description)

formatDataForJavaDoc

protected String formatDataForJavaDoc(GeneratedType type,
                                      String additionalComment)

formatDataForJavaDoc

protected static String formatDataForJavaDoc(TypeMember type,
                                             String additionalComment)

asCode

public String asCode(String text)

asLink

public String asLink(String text)

formatToParagraph

protected static String formatToParagraph(String text)

generateToString

protected CharSequence generateToString(Collection<GeneratedProperty> properties)

generateParameters

protected CharSequence generateParameters(List<MethodSignature.Parameter> parameters)

Template method which generates method parameters with their types from parameters.

Parameters:

parameters - list of parameter instances which are transformed to the method parameters

Returns:

string with the list of the method parameters with their types in JAVA format

emitConstant

protected CharSequence emitConstant(Constant c)

generateCheckers

protected CharSequence generateCheckers(GeneratedProperty field,
                                        Restrictions restrictions,
                                        Type actualType)

checkArgument

protected CharSequence checkArgument(GeneratedProperty property,
                                     Restrictions restrictions,
                                     Type actualType,
                                     String value)

hashCodeResult

protected CharSequence hashCodeResult(Collection<GeneratedProperty> properties)