Package org.jlayer.impl

Class LayerWriter

java.lang.Object

org.jlayer.impl.LayerWriter

class LayerWriter
extends Object

This class provides the method writeFiles(), which is used to create wrapper classes and the related interface and abstract classes.

Author:

Gerd Kock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	LayerWriter.DimKind
private static enum	LayerWriter.LevelKind
private static class	LayerWriter.ParamInfo
private static enum	LayerWriter.TypeKind

Field Summary

Fields

Modifier and Type	Field	Description
private StringBuilder	abstractCode
private Filer	filer
private StringBuilder	interfaceCode
private StringBuilder	layerCode
private CharSequence	packageName
private CharSequence	rootALayerType
private CharSequence	rootILayerType
private CharSequence	rootLayerType
private Unit	rootUnit
private CharSequence	rootUnitType
private String	tab0

Constructor Summary

Constructors

Constructor	Description
LayerWriter(ProcessingEnvironment pe)

Method Summary

Modifier and Type	Method	Description
private void	appendActionItemInits(StringBuilder srcCode, String tab, LayerWriter.ParamInfo paramInfo)
private void	appendActionItemLocals(StringBuilder srcCode, String tab, LayerWriter.ParamInfo paramInfo)
private void	appendALayerConstructors(StringBuilder srcCode, Unit unit, CharSequence unitType, CharSequence ilayerType, CharSequence alayerType, CharSequence layerType, LayerWriter.DimKind dimKind)
private void	appendArrayDeclaration(StringBuilder srcCode, LayerWriter.DimKind dimKind, Unit.TypeDescriptor typeDescr)
private void	appendChecksBeforeCall(StringBuilder srcCode, Unit.MethodDescriptor mDescr)
private void	appendDxMethod(StringBuilder srcCode, Unit.MethodDescriptor mDescr, CharSequence unitType, LayerWriter.DimKind dimKind)
private void	appendDxMethods(StringBuilder srcCode, Unit unit, CharSequence unitType, LayerWriter.DimKind dimKind)
private void	appendFieldCodeD1(StringBuilder srcCode, Unit unit, CharSequence unitType)
private void	appendFieldCodeD2(StringBuilder srcCode, Unit unit, CharSequence unitType)
private void	appendFieldCodeD3(StringBuilder srcCode, Unit unit, CharSequence unitType)
private void	appendFieldCodeNN(StringBuilder srcCode, Unit unit, CharSequence unitType, CharSequence layerType)
private void	appendFieldItems(StringBuilder srcCode, Unit unit, CharSequence unitType, LayerWriter.DimKind dimKind)
private void	appendImports(StringBuilder srcCode)
private void	appendIndexCode(StringBuilder srcCode, List<String> indexNames, LayerWriter.DimKind dimKind, int no)
private void	appendIndexDeclaration(StringBuilder srcCode, LayerWriter.DimKind dimKind)
private void	appendLayerConstructors(StringBuilder srcCode, Unit unit, CharSequence unitType, CharSequence ilayerType, CharSequence alayerType, CharSequence layerType, LayerWriter.DimKind dimKind)
private void	appendLayerItems(StringBuilder srcCode, LayerWriter.LevelKind levelKind, Unit unit, CharSequence unitType, CharSequence iLayerType, CharSequence aLayerType, CharSequence layerType)
private void	appendNNMethods(StringBuilder srcCode, Unit unit, CharSequence unitType)
private void	appendSignature(StringBuilder srcCode, CharSequence unitType, Unit.MethodDescriptor mDescr, LayerWriter.DimKind dimKind, String endChar)
private void	createSourceCode(StringBuilder srcCode)
private String	getArrayType(LayerWriter.DimKind kind, String type)
private String	getDxCall(CharSequence unitType, Unit.MethodDescriptor mDescr, LayerWriter.DimKind dimKind)
private String	getDxCast(LayerWriter.DimKind dimKind)
private String	getLayerTypeName(CharSequence unitType, Unit.TypeDescriptor typeDescr, LayerWriter.DimKind dimKind, LayerWriter.TypeKind typeKind)	generates the layer type name for a field, a return type or a parameter
private String	getLeftSide(LayerWriter.DimKind kind)
private String	getModifiers0(Set<Modifier> modifiers)
private String	getModifiers1(Set<Modifier> modifiers)
private String	getModifiers1F(Set<Modifier> modifiers)
private String	getModifiers2(Set<Modifier> modifiers)
private String	getModifiers2F(Set<Modifier> modifiers)
private String	getModifiers3(Set<Modifier> modifiers)
private String	getParamCalls(String prefix, LayerWriter.ParamInfo paramInfo)
private String	getParamDecls(String prefix, LayerWriter.ParamInfo paramInfo)
private LayerWriter.ParamInfo	getParamInfo(CharSequence unitType, Unit.MethodDescriptor mDescr, LayerWriter.DimKind dimKind, boolean treatVP)
private String	getRightSide(String methodName, int noOfPars, List<String> paramCalls)
private String	tab(int x)
(package private) void	writeFiles(Element rootElem, Unit nextUnit)	is used to write layer classes and corresponding interfaces and abstract classes.

Methods inherited from class java.lang.Object

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

Field Details

tab0

private String tab0

filer

private Filer filer

packageName

private CharSequence packageName

rootUnit

private Unit rootUnit

rootUnitType

private CharSequence rootUnitType

rootILayerType

private CharSequence rootILayerType

rootALayerType

private CharSequence rootALayerType

rootLayerType

private CharSequence rootLayerType

interfaceCode

private StringBuilder interfaceCode

abstractCode

private StringBuilder abstractCode

layerCode

private StringBuilder layerCode

Constructor Details

LayerWriter

LayerWriter(ProcessingEnvironment pe)

Method Details

tab

private String tab(int x)

writeFiles

void writeFiles(Element rootElem,
 Unit nextUnit)
         throws IOException

is used to write layer classes and corresponding interfaces and abstract classes.

If rootElem represents the layer unit class MyUnit.java, the three generated files are:

• interface ILayer_MyUnit_.java
• abstract class ALayer_MyUnit_.java
• layer class Layer_MyUnit_.java

Parameters:

rootElem - this element represents a class object

nextUnit - this unit contains the results of visiting that class

Throws:

IOException - may be raised while creating the corresponding source file or getting a writer for that file object

createSourceCode

private void createSourceCode(StringBuilder srcCode)

appendImports

private void appendImports(StringBuilder srcCode)

appendLayerItems

private void appendLayerItems(StringBuilder srcCode,
 LayerWriter.LevelKind levelKind,
 Unit unit,
 CharSequence unitType,
 CharSequence iLayerType,
 CharSequence aLayerType,
 CharSequence layerType)

appendALayerConstructors

private void appendALayerConstructors(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType,
 CharSequence ilayerType,
 CharSequence alayerType,
 CharSequence layerType,
 LayerWriter.DimKind dimKind)

appendLayerConstructors

private void appendLayerConstructors(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType,
 CharSequence ilayerType,
 CharSequence alayerType,
 CharSequence layerType,
 LayerWriter.DimKind dimKind)

appendIndexCode

private void appendIndexCode(StringBuilder srcCode,
 List<String> indexNames,
 LayerWriter.DimKind dimKind,
 int no)

appendFieldCodeD1

private void appendFieldCodeD1(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType)

appendFieldCodeD2

private void appendFieldCodeD2(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType)

appendFieldCodeD3

private void appendFieldCodeD3(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType)

appendFieldCodeNN

private void appendFieldCodeNN(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType,
 CharSequence layerType)

appendFieldItems

private void appendFieldItems(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType,
 LayerWriter.DimKind dimKind)

appendDxMethods

private void appendDxMethods(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType,
 LayerWriter.DimKind dimKind)

appendDxMethod

private void appendDxMethod(StringBuilder srcCode,
 Unit.MethodDescriptor mDescr,
 CharSequence unitType,
 LayerWriter.DimKind dimKind)

appendNNMethods

private void appendNNMethods(StringBuilder srcCode,
 Unit unit,
 CharSequence unitType)

getParamInfo

private LayerWriter.ParamInfo getParamInfo(CharSequence unitType,
 Unit.MethodDescriptor mDescr,
 LayerWriter.DimKind dimKind,
 boolean treatVP)

appendSignature

private void appendSignature(StringBuilder srcCode,
 CharSequence unitType,
 Unit.MethodDescriptor mDescr,
 LayerWriter.DimKind dimKind,
 String endChar)

appendActionItemInits

private void appendActionItemInits(StringBuilder srcCode,
 String tab,
 LayerWriter.ParamInfo paramInfo)

appendActionItemLocals

private void appendActionItemLocals(StringBuilder srcCode,
 String tab,
 LayerWriter.ParamInfo paramInfo)

appendArrayDeclaration

private void appendArrayDeclaration(StringBuilder srcCode,
 LayerWriter.DimKind dimKind,
 Unit.TypeDescriptor typeDescr)

appendIndexDeclaration

private void appendIndexDeclaration(StringBuilder srcCode,
 LayerWriter.DimKind dimKind)

appendChecksBeforeCall

private void appendChecksBeforeCall(StringBuilder srcCode,
 Unit.MethodDescriptor mDescr)

getModifiers0

private String getModifiers0(Set<Modifier> modifiers)

getModifiers1

private String getModifiers1(Set<Modifier> modifiers)

getModifiers1F

private String getModifiers1F(Set<Modifier> modifiers)

getModifiers2

private String getModifiers2(Set<Modifier> modifiers)

getModifiers2F

private String getModifiers2F(Set<Modifier> modifiers)

getModifiers3

private String getModifiers3(Set<Modifier> modifiers)

getArrayType

private String getArrayType(LayerWriter.DimKind kind,
 String type)

getParamDecls

private String getParamDecls(String prefix,
 LayerWriter.ParamInfo paramInfo)

getParamCalls

private String getParamCalls(String prefix,
 LayerWriter.ParamInfo paramInfo)

getRightSide

private String getRightSide(String methodName,
 int noOfPars,
 List<String> paramCalls)

getLeftSide

private String getLeftSide(LayerWriter.DimKind kind)

getDxCast

private String getDxCast(LayerWriter.DimKind dimKind)

getDxCall

private String getDxCall(CharSequence unitType,
 Unit.MethodDescriptor mDescr,
 LayerWriter.DimKind dimKind)

getLayerTypeName

private String getLayerTypeName(CharSequence unitType,
 Unit.TypeDescriptor typeDescr,
 LayerWriter.DimKind dimKind,
 LayerWriter.TypeKind typeKind)

generates the layer type name for a field, a return type or a parameter

Parameters:

unitType - the name of the current unit type

typeDescr - the type of the field, return type or parameter under consideration

dimKind - the dimensionality of the current layer type to be generated (D1, D2, D3, NN)

typeKind - the kind of type to be generated

Returns:

the generated layer type