de.tsl2.nano.util.codegen

Class ClassGenerator

java.lang.Object

de.tsl2.nano.util.codegen.ClassGenerator

Direct Known Subclasses:

PackageGenerator, PropertiesAsConstantsGenerator

public class ClassGenerator
extends Object

class to generate code from a given file. This implementation uses source files of type java. please override the methods...

Version:

$Revision: 1.0 $

Author:

ts 07.12.2008

See Also:

getModel(String, ClassLoader), getDefaultClassloader(), ...to have your own ClassGenerator. The default implementation of this basic generator expects a java bean (class package) and creates a java file. Howto start (example): mainClass: de.tsl2.nano.util.codegen.ClassGenerator arguments: bin/codegen/beanclass.vm

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DEST_POSTFIX
static String	DEFAULT_DEST_PREFIX
static String	DEST_FILENAME_PATTERN
static String	DEST_POSTFIX
static String	DEST_PREFIX
protected static Log	LOG
static String	POSTFIX_CLS
static String	SRC_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate(String modelFile, String templateFile, Properties properties)
void	generate(String modelFile, String templateFile, String destFile, Properties properties, ClassLoader classLoader) generates a java class file through the information of the 'modelFile' and the template 'templateFile'.
protected ClassLoader	getDefaultClassloader() override this method to use your classloader
protected String	getDefaultDestinationFile(String modelFile) override this method to provide a default destination file
protected String	getDestinationClassName(String sourceFile, String destinationFileName) tries to extract the destination class name. precondition is, that package-path starts equal on model and destination!
protected String	getDestinationPackageName(String sourceFile, String destinationFileName) extracts the package name from the result of getDestinationClassName(String, String).
protected Object	getModel(String modelFile, ClassLoader classLoader) override this method to provide your class model (the source class)
protected GeneratorUtility	getUtilityInstance() override this method to use your special utility
protected void	init() initializes the velocity engine.
static ClassGenerator	instance() instance
protected static ClassGenerator	instance(ClassGenerator newInstance) returns a singelton instance of type ClassGenerator. if the singelton is null, the argument will be used as singelton.
protected static ClassGenerator	instance(String className)
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

SRC_NAME

public static final String SRC_NAME

See Also:

Constant Field Values

DEST_PREFIX

public static final String DEST_PREFIX

See Also:

Constant Field Values

DEST_POSTFIX

public static final String DEST_POSTFIX

See Also:

Constant Field Values

DEST_FILENAME_PATTERN

public static final String DEST_FILENAME_PATTERN

See Also:

Constant Field Values

DEFAULT_DEST_PREFIX

public static final String DEFAULT_DEST_PREFIX

See Also:

Constant Field Values

DEFAULT_DEST_POSTFIX

public static final String DEFAULT_DEST_POSTFIX

See Also:

Constant Field Values

POSTFIX_CLS

public static final String POSTFIX_CLS

See Also:

Constant Field Values

Constructor Detail

ClassGenerator

protected ClassGenerator()

Method Detail

instance

public static final ClassGenerator instance()

instance

Returns:

singelton instance

instance

protected static final ClassGenerator instance(ClassGenerator newInstance)

returns a singelton instance of type ClassGenerator. if the singelton is null, the argument will be used as singelton.

Parameters:

newInstance - singelton instance, if singelton instance is null.

Returns:

singelton

instance

protected static final ClassGenerator instance(String className)

Parameters:

className - generator class name

Returns:

new singelton class generator instance

init

protected void init()

initializes the velocity engine.

generate

public void generate(String modelFile,
                     String templateFile,
                     Properties properties)
              throws Exception

Throws:

Exception

See Also:

generate(String, String, String, Properties, ClassLoader)

generate

public void generate(String modelFile,
                     String templateFile,
                     String destFile,
                     Properties properties,
                     ClassLoader classLoader)
              throws Exception

generates a java class file through the information of the 'modelFile' and the template 'templateFile'. The generate class file will be stored at 'destFile'.

Parameters:

modelFile - the source file (getModel(String, ClassLoader))

templateFile - a velocity template (full path, not classpath!)

destFile - the destination file

classLoader - used in (getModel(String, ClassLoader))

Throws:

Exception

getUtilityInstance

protected GeneratorUtility getUtilityInstance()

override this method to use your special utility

Returns:

utility instance

getModel

protected Object getModel(String modelFile,
                          ClassLoader classLoader)

override this method to provide your class model (the source class)

Parameters:

modelFile - source file name (normally a beans java file name)

classLoader - classloader to be used to load modelFile class.

Returns:

getDefaultDestinationFile

protected String getDefaultDestinationFile(String modelFile)

override this method to provide a default destination file

Parameters:

modelFile - source file

Returns:

default classloader

See Also:

getModel(String, ClassLoader)

getDestinationClassName

protected String getDestinationClassName(String sourceFile,
                                         String destinationFileName)

tries to extract the destination class name. precondition is, that package-path starts equal on model and destination!

Parameters:

sourceFile - source class name

destinationFileName - dest file name

Returns:

dest class name

getDestinationPackageName

protected String getDestinationPackageName(String sourceFile,
                                           String destinationFileName)

extracts the package name from the result of getDestinationClassName(String, String).

Parameters:

sourceFile - source class name

destinationFileName - dest file name

Returns:

dest package name

See Also:

getDestinationClassName(String, String)

getDefaultClassloader

protected ClassLoader getDefaultClassloader()

override this method to use your classloader

Returns:

generators default classloader

main

public static void main(String[] args)
                 throws Exception

Parameters:

args - model file name and template

Throws:

Exception - any exception!