net.sf.mmm.util.gwt.base.rebind

Class AbstractIncrementalGenerator

java.lang.Object

com.google.gwt.core.ext.Generator

com.google.gwt.core.ext.IncrementalGenerator

net.sf.mmm.util.gwt.base.rebind.AbstractIncrementalGenerator

Direct Known Subclasses:

AbstractNlsBundleGenerator, AbstractPojoDescriptorGenerator, NlsBundleFactoryGenerator, RemoteInvocationServiceCallerGenerator

public abstract class AbstractIncrementalGenerator
extends com.google.gwt.core.ext.IncrementalGenerator

This is the abstract base implementation for IncrementalGenerators for GWT environments, that generates a Class from a single input type. If the input type has not been modified since the last generation the generated result is reused by default.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractIncrementalGenerator() The constructor.

Method Summary

Modifier and Type	Method and Description
protected String	createClassName(com.google.gwt.core.ext.typeinfo.JClassType inputType) This method creates the simple name of the Class to generate.
protected String	generate(com.google.gwt.core.ext.typeinfo.JClassType inputType, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context) This method performs the actual generation of the Class to rebind.
protected abstract void	generateClassContents(com.google.gwt.core.ext.typeinfo.JClassType inputType, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.user.rebind.SourceWriter sourceWriter, String simpleName, com.google.gwt.core.ext.GeneratorContext context) This method generates the actual contents of the Class to generate.
protected abstract void	generateClassDeclaration(com.google.gwt.core.ext.typeinfo.JClassType inputType, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.user.rebind.ClassSourceFileComposerFactory sourceComposerFactory, com.google.gwt.core.ext.GeneratorContext context) This method generates the additional things for the class declaration.
protected void	generateDefaultConstructor(com.google.gwt.user.rebind.SourceWriter sourceWriter, String simpleName) Generates the the default constructor.
protected abstract void	generateImportStatements(com.google.gwt.core.ext.typeinfo.JClassType inputType, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.user.rebind.ClassSourceFileComposerFactory sourceComposerFactory, com.google.gwt.core.ext.GeneratorContext context) This method generates the import statements.
com.google.gwt.core.ext.RebindResult	generateIncrementally(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, String typeName)
protected void	generateSourceCloseBlock(com.google.gwt.user.rebind.SourceWriter sourceWriter) This method generates the source code to close a block (method body, if-block, while-block, etc.).
protected void	generateSourcePublicConstructorDeclaration(com.google.gwt.user.rebind.SourceWriter sourceWriter, String methodName) This method generates the source code for a public method or constructor including the opening brace and indentation.
protected void	generateSourcePublicMethodDeclaration(com.google.gwt.user.rebind.SourceWriter sourceWriter, com.google.gwt.core.ext.typeinfo.JMethod method) This method generates the source code for a public method declaration including the opening brace and indentation.
protected void	generateSourcePublicMethodDeclaration(com.google.gwt.user.rebind.SourceWriter sourceWriter, String returnType, String methodName, String arguments, boolean override) This method generates the source code for a public method or constructor including the opening brace and indentation.
protected boolean	isCachedResultObsolete(com.google.gwt.core.ext.CachedGeneratorResult cachedGeneratorResult, String typeName) This method determines whether a CachedGeneratorResult is obsolete or can be reused.

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

generate, generateNonIncrementally, getVersionId

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

escape, escapeClassName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIncrementalGenerator

public AbstractIncrementalGenerator()

The constructor.

Method Detail

generateIncrementally

public com.google.gwt.core.ext.RebindResult generateIncrementally(com.google.gwt.core.ext.TreeLogger logger,
                                                                  com.google.gwt.core.ext.GeneratorContext context,
                                                                  String typeName)
                                                           throws com.google.gwt.core.ext.UnableToCompleteException

Specified by:

generateIncrementally in class com.google.gwt.core.ext.IncrementalGenerator

Throws:

com.google.gwt.core.ext.UnableToCompleteException

generate

protected String generate(com.google.gwt.core.ext.typeinfo.JClassType inputType,
                          com.google.gwt.core.ext.TreeLogger logger,
                          com.google.gwt.core.ext.GeneratorContext context)

This method performs the actual generation of the Class to rebind.

Parameters:

inputType - is the JClassType reflecting the input-type that triggered the generation via GWT.create(Class).

logger - is the TreeLogger.

context - is the GeneratorContext.

Returns:

the fully qualified name of the generated class.

generateImportStatements

protected abstract void generateImportStatements(com.google.gwt.core.ext.typeinfo.JClassType inputType,
                                                 com.google.gwt.core.ext.TreeLogger logger,
                                                 com.google.gwt.user.rebind.ClassSourceFileComposerFactory sourceComposerFactory,
                                                 com.google.gwt.core.ext.GeneratorContext context)

This method generates the import statements. It shall only perform invocations of ClassSourceFileComposerFactory.addImport(String) to the given ClassSourceFileComposerFactory.

Parameters:

inputType - is the JClassType reflecting the input-type that triggered the generation via GWT.create(Class).

logger - is the TreeLogger.

sourceComposerFactory - is the ClassSourceFileComposerFactory.

context - is the GeneratorContext.

generateClassDeclaration

protected abstract void generateClassDeclaration(com.google.gwt.core.ext.typeinfo.JClassType inputType,
                                                 com.google.gwt.core.ext.TreeLogger logger,
                                                 com.google.gwt.user.rebind.ClassSourceFileComposerFactory sourceComposerFactory,
                                                 com.google.gwt.core.ext.GeneratorContext context)

This method generates the additional things for the class declaration. This is the place where to invoke methods like

• ClassSourceFileComposerFactory.setSuperclass(String)
• ClassSourceFileComposerFactory.addImplementedInterface(String)
• ClassSourceFileComposerFactory.addAnnotationDeclaration(String)
• ClassSourceFileComposerFactory.makeInterface()
• ClassSourceFileComposerFactory.setJavaDocCommentForClass(String)

on the given ClassSourceFileComposerFactory. E.g.

 sourceComposerFactory.addImplementedInterface(inputType.getQualifiedSourceName());
 

Parameters:

inputType - is the JClassType reflecting the input-type that triggered the generation via GWT.create(Class).

logger - is the TreeLogger.

sourceComposerFactory - is the ClassSourceFileComposerFactory.

context - is the GeneratorContext.

generateClassContents

protected abstract void generateClassContents(com.google.gwt.core.ext.typeinfo.JClassType inputType,
                                              com.google.gwt.core.ext.TreeLogger logger,
                                              com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                              String simpleName,
                                              com.google.gwt.core.ext.GeneratorContext context)

This method generates the actual contents of the Class to generate.

Parameters:

inputType - is the JClassType reflecting the input-type that triggered the generation via GWT.create(Class).

logger - is the TreeLogger.

sourceWriter - is the SourceWriter where to write the source code to.

simpleName - is the simple name of the Class to generate.

context - is the GeneratorContext.

createClassName

protected String createClassName(com.google.gwt.core.ext.typeinfo.JClassType inputType)

This method creates the simple name of the Class to generate. Typically derived from JClassType.getName() of the given inputType with a static suffix or prefix that is specific enough to avoid clashing with existing classes.

Parameters:

inputType - is the JClassType reflecting the input-type that triggered the generation via GWT.create(Class).

Returns:

the simple name of the Class to generate.

generateDefaultConstructor

protected void generateDefaultConstructor(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                          String simpleName)

Generates the the default constructor.

Parameters:

sourceWriter - is the SourceWriter.

simpleName - is the simple name.

generateSourcePublicConstructorDeclaration

protected final void generateSourcePublicConstructorDeclaration(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                                                String methodName)

This method generates the source code for a public method or constructor including the opening brace and indentation.

Parameters:

sourceWriter - is the SourceWriter.

methodName - is the name of the method (or the simple class name for a constructor}.

generateSourcePublicMethodDeclaration

protected final void generateSourcePublicMethodDeclaration(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                                           com.google.gwt.core.ext.typeinfo.JMethod method)

This method generates the source code for a public method declaration including the opening brace and indentation.

Parameters:

sourceWriter - is the SourceWriter.

method - is the JMethod to implement.

generateSourcePublicMethodDeclaration

protected final void generateSourcePublicMethodDeclaration(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                                           String returnType,
                                                           String methodName,
                                                           String arguments,
                                                           boolean override)

This method generates the source code for a public method or constructor including the opening brace and indentation.

Parameters:

sourceWriter - is the SourceWriter.

returnType - is the return type of the method.

methodName - is the name of the method (or the simple class name for a constructor}.

arguments - is the source line with the arguments to the method or constructor.

override - - true if an Override annotation shall be added.

generateSourceCloseBlock

protected final void generateSourceCloseBlock(com.google.gwt.user.rebind.SourceWriter sourceWriter)

This method generates the source code to close a block (method body, if-block, while-block, etc.).

Parameters:

sourceWriter - is the SourceWriter.

isCachedResultObsolete

protected boolean isCachedResultObsolete(com.google.gwt.core.ext.CachedGeneratorResult cachedGeneratorResult,
                                         String typeName)

This method determines whether a CachedGeneratorResult is obsolete or can be reused.

Parameters:

cachedGeneratorResult - is the CachedGeneratorResult.

typeName - is the full-qualified name of the Class to generate.

Returns:

true if the CachedGeneratorResult is obsolete and has to be re-generated, false otherwise (if it can be reused).