fx.codegen.runner.stock

Class TemplateBasedCodegenRunner

java.lang.Object

fx.codegen.runner.stock.TemplateBasedCodegenRunner

All Implemented Interfaces:

CodegenRunner

public class TemplateBasedCodegenRunner
extends java.lang.Object
implements CodegenRunner

This stock CodegenRunner generates source code by replacing tags in a given template with various versions of the names and types of the elements of the configuration tree and their children.


There are two modes of operation:

• OPERATION_MODE__ONE_TO_ONE - one source code item will be generated, using the same provided template, for each one of the elements in the configuration tree
• OPERATION_MODE__ALL_IN_ONE - will generate only one source code item, which will contain many occurrences of the processed template (one occurrence for each element in the configuration tree)

The default operation mode is OPERATION_MODE__ONE_TO_ONE


The following primitive-handling policies are available:

• PRIMITIVE_POLICY__IGNORE - The source code generation process will not run for configuration nodes having primitive data types
• PRIMITIVE_POLICY__ACCEPT - The source code generation process will run for all nodes of the configuration tree, including those which resolve to primitive types

The default primitive-handing policy is PRIMITIVE_POLICY__IGNORE


In order to operate, the TemplateBasedCodegenRunner must be provided a TemplateEngineAbstraction. There are stock template engine abstractions available. For a list of what's available, See the package fx.codegen.runner.stock.abstraction.templateengineabstraction

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEAF_POLICY__ACCEPT
static int	LEAF_POLICY__IGNORE
static int	OPERATION_MODE__ALL_IN_ONE
static int	OPERATION_MODE__ONE_TO_ONE

Constructor Summary

Constructors

Constructor and Description
TemplateBasedCodegenRunner()

Method Summary

Modifier and Type	Method and Description
int	getLeafPolicy()
int	getOperationMode()
java.lang.String	getResultNamePattern()
java.lang.String	getTemplateContent()
TemplateEngineAbstraction	getTemplateEngineAbstraction()
java.util.Map<java.lang.String,java.lang.String>	runConfig(ConfigRoot config)
void	setLeafPolicy(int leafPolicy)
void	setOperationMode(int operationMode)
void	setResultNamePattern(java.lang.String resultNamePattern)
void	setTemplateContent(java.lang.String templateContent)
void	setTemplateEngineAbstraction(TemplateEngineAbstraction templateEngineAbstraction)

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_MODE__ONE_TO_ONE

public static final int OPERATION_MODE__ONE_TO_ONE

See Also:

Constant Field Values

OPERATION_MODE__ALL_IN_ONE

public static final int OPERATION_MODE__ALL_IN_ONE

See Also:

Constant Field Values

LEAF_POLICY__ACCEPT

public static final int LEAF_POLICY__ACCEPT

See Also:

Constant Field Values

LEAF_POLICY__IGNORE

public static final int LEAF_POLICY__IGNORE

See Also:

Constant Field Values

Constructor Detail

TemplateBasedCodegenRunner

public TemplateBasedCodegenRunner()

Method Detail

getTemplateContent

public java.lang.String getTemplateContent()

setTemplateContent

public void setTemplateContent(java.lang.String templateContent)

getOperationMode

public int getOperationMode()

setOperationMode

public void setOperationMode(int operationMode)

getLeafPolicy

public int getLeafPolicy()

setLeafPolicy

public void setLeafPolicy(int leafPolicy)

getTemplateEngineAbstraction

public TemplateEngineAbstraction getTemplateEngineAbstraction()

setTemplateEngineAbstraction

public void setTemplateEngineAbstraction(TemplateEngineAbstraction templateEngineAbstraction)

getResultNamePattern

public java.lang.String getResultNamePattern()

setResultNamePattern

public void setResultNamePattern(java.lang.String resultNamePattern)

runConfig

public java.util.Map<java.lang.String,java.lang.String> runConfig(ConfigRoot config)

Specified by:

runConfig in interface CodegenRunner