com.gwtplatform.dispatch.annotation.helper

Class GenerationHelper

java.lang.Object

com.gwtplatform.dispatch.annotation.helper.GenerationHelper

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ClassGenerationHelper, InterfaceGenerationHelper

public class GenerationHelper
extends Object
implements Closeable

GenerationHelper is an internal class that provides common routines only used by the annotation processors.

Author:

Brendan Doherty, Florian Sauter, Stephen Haberman (concept)

Constructor Summary

Constructors

Constructor and Description
GenerationHelper(Writer sourceWriter)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
protected String	determineFinalConstantValue(VariableElement fieldElement) Note that to have a constant value, a field's type must be either a primitive type or String otherwise the value is null.
protected String	determineWrapperClass(TypeMirror type) Returns the name of the wrapper class for a primitive class.
String	firstCharToUpperCase(String charSequence)
void	generateAnnotation(String className, String value)
void	generateConstantFieldDeclaration(VariableElement fieldElement)
void	generateFieldDeclaration(VariableElement fieldElement)
void	generateFieldDeclaration(VariableElement fieldElement, Modifier... modifiers)
void	generateFieldDeclarations(Collection<VariableElement> collection) Generates all field declarations which are included in the passed list.
String	generateFieldList(Collection<VariableElement> fieldElements, boolean withType, boolean leadingComma) Generates a list of Fields.
void	generateFooter()
void	generateImports(Class<?>... imports) Use null as import to separate import groups.
void	generateImports(String... imports)
String	generateModifierList(Modifier... modifiers)
void	generatePackageDeclaration(String packageName) Generates a package declaration.
static String	implode(Object[] segments, String delimiter) Construct a single string from an array of strings, gluing them together with the specified delimiter.
boolean	isConstant(VariableElement fieldElement) Checks if a field contains a static or final modifier.
boolean	isFinal(VariableElement fieldElement) Checks if a field contains a final modifier.
boolean	isPrimitive(TypeMirror type) Checks if a type is a primitive type.
boolean	isStatic(VariableElement fieldElement) Checks if a field contains a static modifier.
protected String	manufactureAccessorName(VariableElement fieldElement)
String	manufactureField(VariableElement fieldElement) Returns the field's type together with the field's simple name.
protected String	manufactureIndentation()
protected String	manufactureSetterName(String fieldName)
protected String	manufactureSetterName(VariableElement fieldElement)
void	print(Object o)
void	print(String s, Object... parameters)
void	println()
void	println(Object o)
void	println(String s, Object... parameters)
void	printWithoutSpaces(String s, Object... parameters)
static String	replaceParameters(String target, Object... parameters) Replaces each placeholder of this string that matches a parameter index.
void	resetWhitespaces()
void	setWhitespaces(int whitespace)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationHelper

public GenerationHelper(Writer sourceWriter)

Method Detail

implode

public static String implode(Object[] segments,
             String delimiter)

Construct a single string from an array of strings, gluing them together with the specified delimiter.

Parameters:

segments - array of strings

delimiter - character that glues the passed strings together

Returns:

imploded and glued list of strings

replaceParameters

public static String replaceParameters(String target,
                       Object... parameters)

Replaces each placeholder of this string that matches a parameter index.

Placeholder format: {int}

Usage:

replaceParameters("{0} int myField = {1};", "private", 20);

Parameters:

target - the string to be replace.

parameters - the replacement parameters

Returns:

the resulting string.

For example:

private int myField = 20;

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

firstCharToUpperCase

public String firstCharToUpperCase(String charSequence)

generateAnnotation

public void generateAnnotation(String className,
                      String value)

generateConstantFieldDeclaration

public void generateConstantFieldDeclaration(VariableElement fieldElement)

generateFieldDeclaration

public void generateFieldDeclaration(VariableElement fieldElement)

generateFieldDeclaration

public void generateFieldDeclaration(VariableElement fieldElement,
                            Modifier... modifiers)

generateFieldDeclarations

public void generateFieldDeclarations(Collection<VariableElement> collection)

Generates all field declarations which are included in the passed list.

generateFieldList

public String generateFieldList(Collection<VariableElement> fieldElements,
                       boolean withType,
                       boolean leadingComma)

Generates a list of Fields.

Usage:

 generateFieldList(myList, true, false)

Generated example:

 
  String myField1, int myField2, final String myField3
 

generateFooter

public void generateFooter()

generateImports

public void generateImports(Class<?>... imports)

Use null as import to separate import groups.

Usage:

 generateImports(EventHandler.class, GwtEvent.class, null,
 GenEventProcessor.class)

Generated example:

 
  import EventHandler;
  import EventHandler;

  import GenEventProcessor;
 

TODO: It seems as the compiler can't find GWTP classes during generation - why?

Parameters:

imports - array of classes to be imported

generateImports

public void generateImports(String... imports)

See Also:

generateImports(Class...)

generateModifierList

public String generateModifierList(Modifier... modifiers)

generatePackageDeclaration

public void generatePackageDeclaration(String packageName)

Generates a package declaration.

Generated example:

package com.gwtplatform.dispatch.annotation.processor;

isConstant

public boolean isConstant(VariableElement fieldElement)

Checks if a field contains a static or final modifier.

isFinal

public boolean isFinal(VariableElement fieldElement)

Checks if a field contains a final modifier.

isPrimitive

public boolean isPrimitive(TypeMirror type)

Checks if a type is a primitive type.

isStatic

public boolean isStatic(VariableElement fieldElement)

Checks if a field contains a static modifier.

manufactureField

public String manufactureField(VariableElement fieldElement)

Returns the field's type together with the field's simple name.

print

public void print(Object o)

print

public void print(String s,
         Object... parameters)

println

public void println()

println

public void println(Object o)

println

public void println(String s,
           Object... parameters)

printWithoutSpaces

public void printWithoutSpaces(String s,
                      Object... parameters)

resetWhitespaces

public void resetWhitespaces()

setWhitespaces

public void setWhitespaces(int whitespace)

determineFinalConstantValue

protected String determineFinalConstantValue(VariableElement fieldElement)

Note that to have a constant value, a field's type must be either a primitive type or String otherwise the value is null.

determineWrapperClass

protected String determineWrapperClass(TypeMirror type)

Returns the name of the wrapper class for a primitive class.

manufactureAccessorName

protected String manufactureAccessorName(VariableElement fieldElement)

manufactureSetterName

protected String manufactureSetterName(String fieldName)

manufactureSetterName

protected String manufactureSetterName(VariableElement fieldElement)

manufactureIndentation

protected String manufactureIndentation()