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

Class TextTemplateUtil

java.lang.Object

org.opendaylight.mdsal.binding.javav2.java.api.generator.util.TextTemplateUtil

public final class TextTemplateUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOT

Method Summary

Modifier and Type	Method and Description
static String	asArguments(List<GeneratedProperty> parameters) Template method which generates sequence of the names of the class attributes.
static String	asJavadoc(String comment) Template method which generates JAVA comments.
static String	encodeAngleBrackets(String description) Encodes angle brackets in yang statement description.
static String	fieldName(GeneratedProperty property) sets fieldname according to property for return type.
static String	formatDataForJavaDoc(GeneratedType type) Returns formatted type description.
static String	formatDataForJavaDoc(GeneratedType type, String additionalComment) Returns formatted Javadoc with possible additional comment, based on type.
static String	formatDataForJavaDocBuilder(String typeName) Returns formatted Javadoc, based on type.
static String	formatSchemaPath(String moduleName, Iterable<org.opendaylight.yangtools.yang.common.QName> schemaPath)
static String	getAccessModifier(AccessModifier modifier) Util method for unionTemplateBuilderTemplate.
static String	getClarification() util method for unionTemplateBuilderTemplate.
static String	getJavaDocForInterface(MethodSignature methodSignature) Returns related Javadoc.
static String	getPropertyList(List<GeneratedProperty> properties) Returns list of properties as formatted String.
static Restrictions	getRestrictions(Type currentType) Extracts available restrictions from given type.
static String	getSimpleNameForBuilder() Returns simple name of underlying class.
static String	getSourcePath(org.opendaylight.yangtools.yang.model.api.Module module, Function<org.opendaylight.yangtools.yang.model.api.Module,Optional<String>> moduleFilePathResolver) Returns source path as String.
static String	getterMethodName(GeneratedProperty field) Helper method for building getter.
static boolean	hasBuilderClass(GeneratedType type)
static String	paramValue(Type returnType, String paramName) Returns parameter name, based on given Type.
static String	propertyNameFromGetter(MethodSignature getter) Cuts prefix from getter name.
static String	propsAsArgs(Iterable<GeneratedProperty> properties) Returns collection of properties as formatted String.
static String	propsAsList(Iterable<GeneratedProperty> properties, String booleanName) Returns properties as formatted String.
static String	setterMethod(GeneratedProperty field, String typeName, String returnTypeName) Returns built setter method body from input parameters.
static String	toFirstLower(String str) Makes start of getter name LowerCase.
static String	toFirstUpper(String str) Makes start of getter name uppercase.
static String	valueForBits(List<GeneratedProperty> properties) Returns properties names in formatted string.
static String	wrapToDocumentation(String text) Wraps text as documentation, used in enum description.

Methods inherited from class java.lang.Object

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

Field Detail

DOT

public static final String DOT

See Also:

Constant Field Values

Method Detail

toFirstLower

public static String toFirstLower(String str)

Makes start of getter name LowerCase.

Parameters:

str - getter name without prefix

Returns:

getter name starting in LowerCase

wrapToDocumentation

public static String wrapToDocumentation(String text)

Wraps text as documentation, used in enum description.

Parameters:

text - text for wrapping

Returns:

wrapped text

formatDataForJavaDocBuilder

public static String formatDataForJavaDocBuilder(String typeName)

Returns formatted Javadoc, based on type.

Parameters:

typeName - given type name

Returns:

formatted Javadoc, based on type

formatDataForJavaDoc

public static String formatDataForJavaDoc(GeneratedType type,
                                          String additionalComment)

Returns formatted Javadoc with possible additional comment, based on type.

Parameters:

type - given type

additionalComment - additional comment to format

Returns:

formatted Javadoc with possible additional comment, based on type

formatDataForJavaDoc

public static String formatDataForJavaDoc(GeneratedType type)

Returns formatted type description.

Parameters:

type - given type

Returns:

formatted type description

hasBuilderClass

public static boolean hasBuilderClass(GeneratedType type)

formatSchemaPath

public static String formatSchemaPath(String moduleName,
                                      Iterable<org.opendaylight.yangtools.yang.common.QName> schemaPath)

valueForBits

public static String valueForBits(List<GeneratedProperty> properties)

Returns properties names in formatted string.

Parameters:

properties - list of given properties

Returns:

properties names in formatted string

paramValue

public static String paramValue(Type returnType,
                                String paramName)

Returns parameter name, based on given Type.

Parameters:

returnType - given type

paramName - parameter name

Returns:

parameter name, based on given Type

asJavadoc

public static String asJavadoc(String comment)

Template method which generates JAVA comments. InterfaceTemplate

Parameters:

comment - comment string with the comment for whole JAVA class

Returns:

string with comment in JAVA format

getJavaDocForInterface

public static String getJavaDocForInterface(MethodSignature methodSignature)

Returns related Javadoc.

Parameters:

methodSignature - method signature

Returns:

related Javadoc

encodeAngleBrackets

public static String encodeAngleBrackets(String description)

Encodes angle brackets in yang statement description.

Parameters:

description - description of a yang statement which is used to generate javadoc comments

Returns:

string with encoded angle brackets

propsAsArgs

public static String propsAsArgs(Iterable<GeneratedProperty> properties)

Returns collection of properties as formatted String.

Parameters:

properties - list of given properties

Returns:

generated properties as formatted String

propsAsList

public static String propsAsList(Iterable<GeneratedProperty> properties,
                                 String booleanName)

Returns properties as formatted String.

Parameters:

properties - list of given properties

booleanName - Java Boolean type name

Returns:

Properties as formatted String

getRestrictions

public static Restrictions getRestrictions(Type currentType)

Extracts available restrictions from given type.

Parameters:

currentType - given type

Returns:

restrictions from given type

fieldName

public static String fieldName(GeneratedProperty property)

sets fieldname according to property for return type. method(type fieldname)

Parameters:

property - type from getter

Returns:

underscored string form

asArguments

public static String asArguments(List<GeneratedProperty> parameters)

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

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

getterMethodName

public static String getterMethodName(GeneratedProperty field)

Helper method for building getter.

Parameters:

field - property name

Returns:

getter for property

setterMethod

public static String setterMethod(GeneratedProperty field,
                                  String typeName,
                                  String returnTypeName)

Returns built setter method body from input parameters.

Parameters:

field - generated property

typeName - type name

returnTypeName - return type name

Returns:

built setter method body

getSimpleNameForBuilder

public static String getSimpleNameForBuilder()

Returns simple name of underlying class.

Returns:

Simple name of underlying class

toFirstUpper

public static String toFirstUpper(String str)

Makes start of getter name uppercase.

Parameters:

str - getter name without prefix

Returns:

getter name starting in uppercase

propertyNameFromGetter

public static String propertyNameFromGetter(MethodSignature getter)

Cuts prefix from getter name.

Parameters:

getter - getter name

Returns:

getter name without prefix

getPropertyList

public static String getPropertyList(List<GeneratedProperty> properties)

Returns list of properties as formatted String.

Parameters:

properties - input list of generated properties

Returns:

formatted property list as String

getClarification

public static String getClarification()

util method for unionTemplateBuilderTemplate.

Returns:

string with clarification for javadoc

getSourcePath

public static String getSourcePath(org.opendaylight.yangtools.yang.model.api.Module module,
                                   Function<org.opendaylight.yangtools.yang.model.api.Module,Optional<String>> moduleFilePathResolver)

Returns source path as String.

Parameters:

module - module

moduleFilePathResolver - function module to module file path

Returns:

formatted String source path

getAccessModifier

public static String getAccessModifier(AccessModifier modifier)

Util method for unionTemplateBuilderTemplate.

Parameters:

modifier - enum representing Java access modifier

Returns:

needed access modifier