name.pehl.piriti.rebind

Class VelocityGenerator

java.lang.Object

com.google.gwt.core.ext.Generator

name.pehl.piriti.rebind.VelocityGenerator

Direct Known Subclasses:

AbstractReaderWriterGenerator, JsonReaderGenerator, JsonWriterGenerator, XmlReaderGenerator, XmlWriterGenerator

public abstract class VelocityGenerator
extends com.google.gwt.core.ext.Generator

Abstract Generator which delegates to a VelocityCreator. The VelocityCreator is responsible for generating the code.

Version:

$LastChangedRevision: 745 $

Author:

$LastChangedBy: harald.pehl $

Constructor Summary

Constructors

Constructor and Description
VelocityGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
String	generate(com.google.gwt.core.ext.TreeLogger treeLogger, com.google.gwt.core.ext.GeneratorContext generatorContext, String rwInterface)
protected abstract String	getInterfaceName() Must return Piritis interface name this generator should generate an implementation for.
protected abstract String	getTemplateName() Returns the velocity template which should be merged.
protected void	populateVelocityContext(org.apache.velocity.VelocityContext velocityContext, com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle) Gives subclasses a chance to put extra information into the velocity context.

Methods inherited from class com.google.gwt.core.ext.Generator

escape

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityGenerator

public VelocityGenerator()

Method Detail

generate

public String generate(com.google.gwt.core.ext.TreeLogger treeLogger,
              com.google.gwt.core.ext.GeneratorContext generatorContext,
              String rwInterface)
                throws com.google.gwt.core.ext.UnableToCompleteException

Specified by:

generate in class com.google.gwt.core.ext.Generator

Throws:

com.google.gwt.core.ext.UnableToCompleteException

populateVelocityContext

protected void populateVelocityContext(org.apache.velocity.VelocityContext velocityContext,
                           com.google.gwt.core.ext.typeinfo.TypeOracle typeOracle)

Gives subclasses a chance to put extra information into the velocity context. This method is empty. The veloity context passed as paramter already contains the following data:

• TypeUtils.class
• An TypeContext instance for the requested reader / writer and relevant model
• The name of the implementation class which should be generated

Parameters:

velocityContext -

typeOracle -

getInterfaceName

protected abstract String getInterfaceName()

Must return Piritis interface name this generator should generate an implementation for. Thus either JsonReader<T>, JsonWriter<T>, XmlReader<T> or XmlWriter<T>

Returns:

the interface this generator should generate an implementation for.

getTemplateName

protected abstract String getTemplateName()

Returns the velocity template which should be merged.

Returns:

the velocity template which should be merged.