ClassTemplate (md-sal 3.0.7-SNAPSHOT API)

java.lang.Object
- org.opendaylight.mdsal.binding.java.api.generator.BaseTemplate
- - org.opendaylight.mdsal.binding.java.api.generator.ClassTemplate

Direct Known Subclasses:

UnionBuilderTemplate, UnionTemplate
```
public class ClassTemplate
extends BaseTemplate
```
Template for generating JAVA class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Iterable<GeneratedProperty>`	`allProperties`
`protected List<Constant>`	`consts` List of constant instances which are generated as JAVA public static final attributes.
`protected List<Enumeration>`	`enums` List of enumeration which are generated as JAVA enum type.
`protected List<GeneratedProperty>`	`finalProperties`
`protected GeneratedTransferObject`	`genTO`
`protected List<GeneratedProperty>`	`parentProperties`
`protected List<GeneratedProperty>`	`properties`
`protected Restrictions`	`restrictions`

Constructor Summary

Constructors
Constructor and Description
`ClassTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType, GeneratedTransferObject genType)` Creates instance of this class with concrete `genType`.
`ClassTemplate(GeneratedTransferObject genType)` Creates instance of this class with concrete `genType`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected CharSequence`	`allValuesConstructor()`
`protected CharSequence`	`annotationDeclaration()`
`protected CharSequence`	`bitsArgs()`
`protected CharSequence`	`body()`
`protected CharSequence`	`constantsDeclarations()` Template method which generates JAVA constants.
`protected CharSequence`	`constructors()`
`protected CharSequence`	`copyConstructor()`
`protected CharSequence`	`defaultInstance()`
`protected CharSequence`	`enumDeclarations()` Template method which generates JAVA enum type.
`protected CharSequence`	`genConstructor(GeneratedProperty property, GeneratedProperty... other)`
`CharSequence`	`generateAsInnerClass()` Generates JAVA class source code (class body only).
`protected CharSequence`	`generateBody(boolean isInnerClass)` Template method which generates class body.
`protected CharSequence`	`generateClassDeclaration(boolean isInnerClass)` Template method which generates JAVA class declaration.
`protected CharSequence`	`generateEquals()` Template method which generates the method `equals()`.
`protected CharSequence`	`generateFields()` Template method which generates JAVA class attributes.
`protected CharSequence`	`generateGetValueForBitsTypeDef()` Template method which generates the method `getValue()` for typedef, which base type is BitsDefinition.
`protected String`	`generateHashCode()` Template method which generates the method `hashCode()`.
`protected CharSequence`	`genUnionConstructor()`
`GeneratedProperty`	`getPropByName(String name)`
`protected CharSequence`	`innerClassesDeclarations()` Template method which generates inner classes inside this interface.
`protected boolean`	`isReadOnly(GeneratedProperty field)`
`protected CharSequence`	`parentConstructor()`
`protected CharSequence`	`propsAsArgs(Iterable<GeneratedProperty> properties)`
`protected CharSequence`	`suidDeclaration()`

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, hashCodeResult, propertyNameFromGetter, setterMethod, wrapToDocumentation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - properties
```
protected final List<GeneratedProperty> properties
```
  - finalProperties
```
protected final List<GeneratedProperty> finalProperties
```
  - parentProperties
```
protected final List<GeneratedProperty> parentProperties
```
  - allProperties
```
protected final Iterable<GeneratedProperty> allProperties
```
  - restrictions
```
protected final Restrictions restrictions
```
  - enums
```
protected final List<Enumeration> enums
```
    List of enumeration which are generated as JAVA enum type.
  - consts
```
protected final List<Constant> consts
```
    List of constant instances which are generated as JAVA public static final attributes.
  - genTO
```
protected final GeneratedTransferObject genTO
```
- Constructor Detail
  - ClassTemplate
```
public ClassTemplate(GeneratedTransferObject genType)
```
    Creates instance of this class with concrete genType.
    
    Parameters:
    
    genType - generated transfer object which will be transformed to JAVA class source code
  - ClassTemplate
```
public ClassTemplate(org.opendaylight.mdsal.binding.java.api.generator.AbstractJavaGeneratedType javaType,
                     GeneratedTransferObject genType)
```
    Creates instance of this class with concrete genType.
    
    Parameters:
    
    genType - generated transfer object which will be transformed to JAVA class source code
- Method Detail
  - generateAsInnerClass
```
public CharSequence generateAsInnerClass()
```
    Generates JAVA class source code (class body only).
    
    Returns:
    
    string with JAVA class body source code
  - body
```
protected CharSequence body()
```
    Specified by:
    
    body in class BaseTemplate
  - generateBody
```
protected CharSequence generateBody(boolean isInnerClass)
```
    Template method which generates class body.
    
    Parameters:
    
    isInnerClass - boolean value which specify if generated class is|isn't inner
    
    Returns:
    
    string with class source code in JAVA format
  - generateGetValueForBitsTypeDef
```
protected CharSequence generateGetValueForBitsTypeDef()
```
    Template method which generates the method getValue() for typedef, which base type is BitsDefinition.
    
    Returns:
    
    string with the getValue() method definition in JAVA format
  - innerClassesDeclarations
```
protected CharSequence innerClassesDeclarations()
```
    Template method which generates inner classes inside this interface.
    
    Returns:
    
    string with the source code for inner classes in JAVA format
  - constructors
```
protected CharSequence constructors()
```
  - allValuesConstructor
```
protected CharSequence allValuesConstructor()
```
  - genUnionConstructor
```
protected CharSequence genUnionConstructor()
```
  - genConstructor
```
protected CharSequence genConstructor(GeneratedProperty property,
                                      GeneratedProperty... other)
```
  - copyConstructor
```
protected CharSequence copyConstructor()
```
  - parentConstructor
```
protected CharSequence parentConstructor()
```
  - defaultInstance
```
protected CharSequence defaultInstance()
```
  - bitsArgs
```
protected CharSequence bitsArgs()
```
  - propsAsArgs
```
protected CharSequence propsAsArgs(Iterable<GeneratedProperty> properties)
```
  - generateClassDeclaration
```
protected CharSequence generateClassDeclaration(boolean isInnerClass)
```
    Template method which generates JAVA class declaration.
    
    Parameters:
    
    isInnerClass - boolean value which specify if generated class is|isn't inner
    
    Returns:
    
    string with class declaration in JAVA format
  - enumDeclarations
```
protected CharSequence enumDeclarations()
```
    Template method which generates JAVA enum type.
    
    Returns:
    
    string with inner enum source code in JAVA format
  - suidDeclaration
```
protected CharSequence suidDeclaration()
```
  - annotationDeclaration
```
protected CharSequence annotationDeclaration()
```
  - constantsDeclarations
```
protected CharSequence constantsDeclarations()
```
    Template method which generates JAVA constants.
    
    Returns:
    
    string with constants in JAVA format
  - generateFields
```
protected CharSequence generateFields()
```
    Template method which generates JAVA class attributes.
    
    Returns:
    
    string with the class attributes in JAVA format
  - isReadOnly
```
protected boolean isReadOnly(GeneratedProperty field)
```
  - generateHashCode
```
protected String generateHashCode()
```
    Template method which generates the method hashCode().
    
    Returns:
    
    string with the hashCode() method definition in JAVA format
  - generateEquals
```
protected CharSequence generateEquals()
```
    Template method which generates the method equals().
    
    Returns:
    
    string with the equals() method definition in JAVA format
  - getPropByName
```
public GeneratedProperty getPropByName(String name)
```

Class ClassTemplate

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

properties

finalProperties

parentProperties

allProperties

restrictions

enums

consts

genTO

Constructor Detail

ClassTemplate

ClassTemplate

Method Detail

generateAsInnerClass

body

generateBody

generateGetValueForBitsTypeDef

innerClassesDeclarations

constructors

allValuesConstructor

genUnionConstructor

genConstructor

copyConstructor

parentConstructor

defaultInstance

bitsArgs

propsAsArgs

generateClassDeclaration

enumDeclarations

suidDeclaration

annotationDeclaration

constantsDeclarations

generateFields

isReadOnly

generateHashCode

generateEquals

getPropByName