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

Class EnumTemplate

java.lang.Object

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

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

public class EnumTemplate
extends BaseTemplate

Template for generating JAVA enumeration type.

Constructor Summary

Constructors

Constructor and Description
EnumTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType, Enumeration enums) Constructs instance of this class with concrete enums.
EnumTemplate(Enumeration enums) Constructs instance of this class with concrete enums.

Method Summary

Modifier and Type	Method and Description
CharSequence	body() Template method which generates enumeration body (declaration + enumeration items).
CharSequence	generateAsInnerClass() Generates only JAVA enumeration source code.
CharSequence	writeEnumeration(Enumeration enumeration)
CharSequence	writeEnumItem(String name, String mappedName, int value, String description)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumTemplate

public EnumTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType,
                    Enumeration enums)

Constructs instance of this class with concrete enums.

Parameters:

enums - enumeration which will be transformed to JAVA source code

EnumTemplate

public EnumTemplate(Enumeration enums)

Constructs instance of this class with concrete enums.

Parameters:

enums - enumeration which will be transformed to JAVA source code

Method Detail

generateAsInnerClass

public CharSequence generateAsInnerClass()

Generates only JAVA enumeration source code.

Returns:

string with JAVA enumeration source code

writeEnumItem

public CharSequence writeEnumItem(String name,
                                  String mappedName,
                                  int value,
                                  String description)

body

public CharSequence body()

Template method which generates enumeration body (declaration + enumeration items).

Specified by:

body in class BaseTemplate

Returns:

string with the enumeration body

writeEnumeration

public CharSequence writeEnumeration(Enumeration enumeration)