Package de.monticore.generating

Class GeneratorEngine

java.lang.Object

de.monticore.generating.GeneratorEngine

public class GeneratorEngine
extends Object

Represents the whole generator engine component. Clients usually need only this class when generating.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_FILE_EXTENSION
protected GeneratorSetup	setup	Contains all configuration data
static final String	TOP_NAME_EXTENSION

Constructor Summary

Constructors

Constructor	Description
GeneratorEngine(GeneratorSetup gs)

Method Summary

Modifier and Type	Method	Description
static boolean	existsHandwrittenClass(MCPath targetPath, String qualifiedName)	Check whewther an handwritten version of that class already exits and shall be integrated (e.g.
StringBuilder	generate(String templateName, ASTNode node, Object... templateArguments)	Processes the template templateName with the given templateArguments and returns the content as StringBuilder.
void	generate(String templateName, Writer writer, ASTNode node, Object... templateArguments)	Processes the template templateName with the node and the given templateArguments and writes the content into the filePath.
void	generate(String templateName, Path filePath, ASTNode node, Object... templateArguments)	Processes the template templateName with the node and the given templateArguments and writes the content into the filePath.
void	generateNoA(String templateName, Writer writer, Object... templateArguments)	Processes the template templateName with the node and the given templateArguments and writes the content into the filePath.
StringBuilder	generateNoA(String templateName, Object... templateArguments)	Processes the template templateName with the given templateArguments and returns the content as StringBuilder.
void	generateNoA(String templateName, Path filePath, Object... templateArguments)	Processes the template templateName with the node and the given templateArguments and writes the content into the filePath.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_FILE_EXTENSION

public static final String DEFAULT_FILE_EXTENSION

See Also:

• Constant Field Values

TOP_NAME_EXTENSION

public static final String TOP_NAME_EXTENSION

See Also:

• Constant Field Values

setup

protected GeneratorSetup setup

Contains all configuration data

Constructor Details

GeneratorEngine

public GeneratorEngine(GeneratorSetup gs)

Method Details

generate

public void generate(String templateName,
 Path filePath,
 ASTNode node,
 Object... templateArguments)

Processes the template templateName with the node and the given templateArguments and writes the content into the filePath. Note: Unless not absolute, the filePath is relative to the configured output directory specified in the GeneratorSetup.

Parameters:

templateName - the template to be processes

filePath - the file path in which the content is to be written

node - the ast node

templateArguments - additional template arguments (if needed).

generateNoA

public void generateNoA(String templateName,
 Path filePath,
 Object... templateArguments)

Processes the template templateName with the node and the given templateArguments and writes the content into the filePath. Note: Unless not absolute, the filePath is relative to the configured output directory specified in the GeneratorSetup.

Parameters:

templateName - the template to be processes

filePath - the file path in which the content is to be written

templateArguments - additional template arguments (if needed).

generate

public void generate(String templateName,
 Writer writer,
 ASTNode node,
 Object... templateArguments)

Processes the template templateName with the node and the given templateArguments and writes the content into the filePath. Note: Unless not absolute, the filePath is relative to the configured output directory specified in the GeneratorSetup.

Parameters:

templateName - the template to be processes

writer - the writer in which the content is to be written

node - the ast node

templateArguments - additional template arguments (if needed).

generateNoA

public void generateNoA(String templateName,
 Writer writer,
 Object... templateArguments)

Processes the template templateName with the node and the given templateArguments and writes the content into the filePath. Note: Unless not absolute, the filePath is relative to the configured output directory specified in the GeneratorSetup.

Parameters:

templateName - the template to be processes

writer - the writer in which the content is to be written

templateArguments - additional template arguments (if needed).

generate

public StringBuilder generate(String templateName,
 ASTNode node,
 Object... templateArguments)

Processes the template templateName with the given templateArguments and returns the content as StringBuilder.

Parameters:

templateName - the template to be processes

node - the ast node

templateArguments - additional template arguments (if needed).

generateNoA

public StringBuilder generateNoA(String templateName,
 Object... templateArguments)

Processes the template templateName with the given templateArguments and returns the content as StringBuilder.

Parameters:

templateName - the template to be processes

templateArguments - additional template arguments (if needed).

existsHandwrittenClass

public static boolean existsHandwrittenClass(MCPath targetPath,
 String qualifiedName)

Check whewther an handwritten version of that class already exits and shall be integrated (e.g. to apply TOP mechanism)