org.apache.tiles.autotag.generate

Class AbstractTemplateSuiteGenerator

java.lang.Object

org.apache.tiles.autotag.generate.AbstractTemplateSuiteGenerator

All Implemented Interfaces:

TemplateSuiteGenerator

Direct Known Subclasses:

FMModelRepositoryGenerator, TLDGenerator, VelocityPropertiesGenerator

public abstract class AbstractTemplateSuiteGenerator
extends Object
implements TemplateSuiteGenerator

A base template suite generator.

Version:

$Rev: 1656976 $ $Date: 2015-02-04 03:27:40 +0100 (Wed, 04 Feb 2015) $

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateSuiteGenerator(org.apache.velocity.app.VelocityEngine velocityEngine) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(OutputLocator outputLocator, String packageName, TemplateSuite suite, Map<String,String> parameters) Generates the code.
protected abstract String	getDirectoryName(String packageName, TemplateSuite suite, Map<String,String> parameters) Calculates and returns the directory where the file will be written..
protected abstract String	getFilename(String packageName, TemplateSuite suite, Map<String,String> parameters) Calculates and returns the filename of the generated file.
protected abstract String	getTemplatePath(String packageName, TemplateSuite suite, Map<String,String> parameters) Calculates and returns the template path.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTemplateSuiteGenerator

public AbstractTemplateSuiteGenerator(org.apache.velocity.app.VelocityEngine velocityEngine)

Constructor.

Parameters:

velocityEngine - The Velocity engine.

Method Detail

generate

public void generate(OutputLocator outputLocator,
            String packageName,
            TemplateSuite suite,
            Map<String,String> parameters)

Description copied from interface: TemplateSuiteGenerator

Generates the code.

Specified by:

generate in interface TemplateSuiteGenerator

Parameters:

outputLocator - The base directory where the code will be put.

packageName - The package name.

suite - The template suite.

parameters - Configuration parameters.

getTemplatePath

protected abstract String getTemplatePath(String packageName,
                     TemplateSuite suite,
                     Map<String,String> parameters)

Calculates and returns the template path.

Parameters:

packageName - The name of the package.

suite - The template suite.

parameters - The map of parameters.

Returns:

The template path.

getFilename

protected abstract String getFilename(String packageName,
                 TemplateSuite suite,
                 Map<String,String> parameters)

Calculates and returns the filename of the generated file.

Parameters:

packageName - The name of the package.

suite - The template suite.

parameters - The map of parameters.

Returns:

The template path.

getDirectoryName

protected abstract String getDirectoryName(String packageName,
                      TemplateSuite suite,
                      Map<String,String> parameters)

Calculates and returns the directory where the file will be written..

Parameters:

packageName - The name of the package.

suite - The template suite.

parameters - The map of parameters.

Returns:

The template path.