Package org.nuiton.eugene

Class Template<M extends Model>

java.lang.Object

org.nuiton.eugene.Template<M>

Type Parameters:

M - Model associated to the generator (input model)

All Implemented Interfaces:

TemplateConfiguration

Direct Known Subclasses:

AbstractGenerator, Transformer

public abstract class Template<M extends Model>
extends Object
implements TemplateConfiguration

Template. TODO javadoc Created: 5 août 2004

Author:

Cédric Pineau - pineau@codelutin.com

Field Summary

Fields

Modifier and Type	Field	Description
protected TemplateConfiguration	configuration
protected List<String>	excludeTemplates
protected List<String>	generatedPackages	List of package to allow generation.
protected M	model	Model
protected ResourcesHelper	resourcesHelper

Fields inherited from interface org.nuiton.eugene.TemplateConfiguration

PROP_CLASS_LOADER, PROP_DEFAULT_PACKAGE, PROP_ENCODING, PROP_EXCLUDE_TEMPLATES, PROP_GENERATED_PACKAGES, PROP_I18N_GETTER_FILE, PROP_LAST_MODIFIED_SOURCE, PROP_OUTPUT_DIRECTORY, PROP_OVERWRITE, PROP_RESOURCE_DIRECTORY, PROP_VERBOSE, PROP_WRITER_REPORT

Constructor Summary

Constructors

Constructor	Description
Template()

Method Summary

Modifier and Type	Method	Description
abstract void	applyTemplate(M model, File destDir)
ClassLoader	getClassLoader()
TemplateConfiguration	getConfiguration()
String	getEncoding()
List<String>	getExcludeTemplates()
protected List<String>	getGeneratedPackages()
long	getLastModifiedSource()
protected LogProxy	getLog()
M	getModel()
boolean	getOverwrite()	Deprecated. since 2.0.2, prefer use the isOverwrite() method
Properties	getProperties()
String	getProperty(String key)
<V> V	getProperty(String key, Class<V> type)
protected ResourcesHelper	getResourcesHelper()
WriterReport	getWriterReport()
boolean	isOverwrite()
boolean	isVerbose()
void	setConfiguration(TemplateConfiguration configuration)
void	setLog(LogProxy log)
void	setProperty(String key, Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.eugene.TemplateConfiguration

getI18nGetterFile, setI18nGetterFile

Field Detail

configuration

protected TemplateConfiguration configuration

excludeTemplates

protected List<String> excludeTemplates

generatedPackages

protected List<String> generatedPackages

List of package to allow generation. If null or empty, generate all packages.

model

protected M extends Model model

Model

resourcesHelper

protected ResourcesHelper resourcesHelper

Constructor Detail

Template

public Template()

Method Detail

getLog

protected LogProxy getLog()

setLog

public void setLog(LogProxy log)

applyTemplate

public abstract void applyTemplate(M model,
                                   File destDir)
                            throws IOException

Throws:

IOException

getConfiguration

public TemplateConfiguration getConfiguration()

setConfiguration

public void setConfiguration(TemplateConfiguration configuration)

getOverwrite

@Deprecated
public boolean getOverwrite()

Deprecated.

since 2.0.2, prefer use the isOverwrite() method

Returns:

true if must overwrite ouput

isOverwrite

public boolean isOverwrite()

Specified by:

isOverwrite in interface TemplateConfiguration

Returns:

true if must regenerate files even if they are up to date

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface TemplateConfiguration

Returns:

true if build is verbose.

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface TemplateConfiguration

Returns:

encoding to use to read and write files

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface TemplateConfiguration

Returns:

the classloader to use to seek for resources

getLastModifiedSource

public long getLastModifiedSource()

Specified by:

getLastModifiedSource in interface TemplateConfiguration

getProperties

public Properties getProperties()

Specified by:

getProperties in interface TemplateConfiguration

getProperty

public <V> V getProperty(String key,
                         Class<V> type)

Specified by:

getProperty in interface TemplateConfiguration

getProperty

public String getProperty(String key)

Specified by:

getProperty in interface TemplateConfiguration

getWriterReport

public WriterReport getWriterReport()

Specified by:

getWriterReport in interface TemplateConfiguration

setProperty

public void setProperty(String key,
                        Object value)

Specified by:

setProperty in interface TemplateConfiguration

getGeneratedPackages

protected List<String> getGeneratedPackages()

getExcludeTemplates

public List<String> getExcludeTemplates()

getModel

public M getModel()

getResourcesHelper

protected ResourcesHelper getResourcesHelper()