net.sf.mmm.util.nls.impl.rebind

Class AbstractNlsBundleGenerator

java.lang.Object

com.google.gwt.core.ext.Generator

com.google.gwt.core.ext.IncrementalGenerator

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

net.sf.mmm.util.nls.impl.rebind.AbstractNlsBundleGenerator

Direct Known Subclasses:

NlsBundleGeneratorGwtI18n

public abstract class AbstractNlsBundleGenerator
extends AbstractIncrementalGenerator

This is the abstract base implementation of a GWT Generator for rebinding the NlsBundleFactory implementation.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	VARIABLE_ARGUMENTS
protected static String	VARIABLE_MESSAGE

Constructor Summary

Constructors

Constructor and Description
AbstractNlsBundleGenerator() The constructor.

Method Summary

Modifier and Type	Method and Description
protected 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 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.
private void	generateCreateMessageBlock(com.google.gwt.user.rebind.SourceWriter sourceWriter, boolean hasArguments) Generates the source code block to create a new NlsMessage.
protected void	generateFields(com.google.gwt.user.rebind.SourceWriter sourceWriter, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, com.google.gwt.core.ext.typeinfo.JClassType bundleClass) Generates the (private) fields.
protected 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.
protected void	generateLookupMethod(com.google.gwt.user.rebind.SourceWriter sourceWriter, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, com.google.gwt.core.ext.typeinfo.JMethod method, com.google.gwt.core.ext.typeinfo.JMethod[] methods) Generates the implementation of NlsBundleWithLookup.getMessage(String, Map).
protected void	generateMethod(com.google.gwt.user.rebind.SourceWriter sourceWriter, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, com.google.gwt.core.ext.typeinfo.JMethod method) Generates an implementation of an NlsBundle-method.
protected void	generateMethodBody(com.google.gwt.user.rebind.SourceWriter sourceWriter, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, com.google.gwt.core.ext.typeinfo.JMethod method) Generates an the body of an NlsBundle-method.
protected abstract void	generateMethodMessageBlock(com.google.gwt.user.rebind.SourceWriter sourceWriter, com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, String methodName) Generates the block of the NlsBundle-method body that creates the code block with the String variable VARIABLE_MESSAGE excluding the String declaration.
protected boolean	isLookupMethod(com.google.gwt.core.ext.typeinfo.JMethod method) Determines if the given JMethod is declared in NlsBundleWithLookup.

Methods inherited from class net.sf.mmm.util.gwt.base.rebind.AbstractIncrementalGenerator

createClassName, generate, generateDefaultConstructor, generateIncrementally, generateSourceCloseBlock, generateSourcePublicConstructorDeclaration, generateSourcePublicMethodDeclaration, generateSourcePublicMethodDeclaration, isCachedResultObsolete

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

Field Detail

VARIABLE_MESSAGE

protected static final String VARIABLE_MESSAGE

See Also:

generateMethodMessageBlock(SourceWriter, TreeLogger, GeneratorContext, String), Constant Field Values

VARIABLE_ARGUMENTS

protected static final String VARIABLE_ARGUMENTS

See Also:

generateMethodMessageBlock(SourceWriter, TreeLogger, GeneratorContext, String), Constant Field Values

Constructor Detail

AbstractNlsBundleGenerator

public AbstractNlsBundleGenerator()

The constructor.

Method Detail

generateImportStatements

protected 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)

Description copied from class: AbstractIncrementalGenerator

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

Specified by:

generateImportStatements in class AbstractIncrementalGenerator

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 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)

Description copied from class: AbstractIncrementalGenerator

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());
 

Specified by:

generateClassDeclaration in class AbstractIncrementalGenerator

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 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)

Description copied from class: AbstractIncrementalGenerator

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

Specified by:

generateClassContents in class AbstractIncrementalGenerator

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.

generateLookupMethod

protected void generateLookupMethod(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                    com.google.gwt.core.ext.TreeLogger logger,
                                    com.google.gwt.core.ext.GeneratorContext context,
                                    com.google.gwt.core.ext.typeinfo.JMethod method,
                                    com.google.gwt.core.ext.typeinfo.JMethod[] methods)

Generates the implementation of NlsBundleWithLookup.getMessage(String, Map).

Parameters:

sourceWriter - is the SourceWriter.

logger - is the TreeLogger.

context - is the GeneratorContext.

method - is the NlsBundleWithLookup.getMessage(String, Map)-method to generate an implementation for.

methods - is the list of all declared methods of the bundle. Likely to be ignored but may be used to generate a switch statement with delegations.

generateMethod

protected void generateMethod(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                              com.google.gwt.core.ext.TreeLogger logger,
                              com.google.gwt.core.ext.GeneratorContext context,
                              com.google.gwt.core.ext.typeinfo.JMethod method)

Generates an implementation of an NlsBundle-method.

Parameters:

sourceWriter - is the SourceWriter.

logger - is the TreeLogger.

context - is the GeneratorContext.

method - is the NlsBundle-method to generate an implementation for.

generateMethodBody

protected void generateMethodBody(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                  com.google.gwt.core.ext.TreeLogger logger,
                                  com.google.gwt.core.ext.GeneratorContext context,
                                  com.google.gwt.core.ext.typeinfo.JMethod method)

Generates an the body of an NlsBundle-method.

Parameters:

sourceWriter - is the SourceWriter.

logger - is the TreeLogger.

context - is the GeneratorContext.

method - is the NlsBundle-method to generate an implementation for.

generateCreateMessageBlock

private void generateCreateMessageBlock(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                        boolean hasArguments)

Generates the source code block to create a new NlsMessage.

Parameters:

sourceWriter - is the SourceWriter.

hasArguments - - true if arguments are given, false otherwise.

generateMethodMessageBlock

protected abstract void generateMethodMessageBlock(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                                                   com.google.gwt.core.ext.TreeLogger logger,
                                                   com.google.gwt.core.ext.GeneratorContext context,
                                                   String methodName)

Generates the block of the NlsBundle-method body that creates the code block with the String variable VARIABLE_MESSAGE excluding the String declaration.

Parameters:

sourceWriter - is the SourceWriter.

logger - is the TreeLogger.

context - is the GeneratorContext.

methodName - is the name of the NlsBundle-method to generate.

generateFields

protected void generateFields(com.google.gwt.user.rebind.SourceWriter sourceWriter,
                              com.google.gwt.core.ext.TreeLogger logger,
                              com.google.gwt.core.ext.GeneratorContext context,
                              com.google.gwt.core.ext.typeinfo.JClassType bundleClass)

Generates the (private) fields.

Parameters:

sourceWriter - is the SourceWriter.

logger - is the TreeLogger.

context - is the GeneratorContext.

bundleClass - is the JClassType reflecting the NlsBundle.

isLookupMethod

protected boolean isLookupMethod(com.google.gwt.core.ext.typeinfo.JMethod method)

Determines if the given JMethod is declared in NlsBundleWithLookup.

Parameters:

method - is the JMethod to test.

Returns:

true if the given method is from NlsBundleWithLookup, false otherwise.

See Also:

NlsBundleWithLookup.getMessage(String, Map)