com.gwtplatform.dispatch.annotation.helper

Class BuilderGenerationHelper

java.lang.Object

com.gwtplatform.dispatch.annotation.helper.GenerationHelper

com.gwtplatform.dispatch.annotation.helper.ClassGenerationHelper

com.gwtplatform.dispatch.annotation.helper.BuilderGenerationHelper

All Implemented Interfaces:

Closeable, AutoCloseable

public class BuilderGenerationHelper
extends ClassGenerationHelper

You should consider to use a builder when you are faced with many constructor parameters. Specially mandatory and optional parameters. Here comes the BuilderGenerationHelper into play.

Instead of making the desired object directly, the client calls a constructor (or static factory) with all of the required parameters and gets a builder object. Then the client calls setter-like methods on the builder object to set each optional parameter of interest. Finally, the client calls a parameterless build method to generate the object, which is immutable. The builder is a static member class of the class it builds. This class offers a method to generate a builder like this.

Rules: No optional fields - no Builder. Has required fields and optional fields - Constructor for required fields + Builder. Has optional fields - only Builder.

Author:

Florian Sauter, Brendan Doherty

See Also:

http://my.safaribooksonline.com/9780137150021/ch02lev1sec2

Constructor Summary

Constructors

Constructor and Description
BuilderGenerationHelper(Writer sourceWriter)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generateBuilderBuildMethod(String builderObjectSimpleClassName) Helper method to create the Builder#build() method which returns a concrete object instance.
void	generateBuilderClass(String builderObjectSimpleClassName, Collection<VariableElement> requiredFields, Collection<VariableElement> optionalFields, String... interfaces)
protected void	generateBuilderFieldAssignment(VariableElement fieldElement, Object value)
protected void	generateBuilderHeader()
protected void	generateBuilderInvocationMethod(VariableElement fieldElement)
void	generateCustomBuilderConstructor(String customClassName, Collection<VariableElement> fieldsToBePassedAndAssigned) Creates a private object constructor which should only ever be called by the intern Builder class.

Methods inherited from class com.gwtplatform.dispatch.annotation.helper.ClassGenerationHelper

generateClassHeader, generateConstructorUsingFields, generateEmptyConstructor, generateEquals, generateFieldAccessors, generateFieldAssignment, generateHashCode, generateToString

Methods inherited from class com.gwtplatform.dispatch.annotation.helper.GenerationHelper

close, determineFinalConstantValue, determineWrapperClass, firstCharToUpperCase, generateAnnotation, generateConstantFieldDeclaration, generateFieldDeclaration, generateFieldDeclaration, generateFieldDeclarations, generateFieldList, generateFooter, generateImports, generateImports, generateModifierList, generatePackageDeclaration, implode, isConstant, isFinal, isPrimitive, isStatic, manufactureAccessorName, manufactureField, manufactureIndentation, manufactureSetterName, manufactureSetterName, print, print, println, println, println, printWithoutSpaces, replaceParameters, resetWhitespaces, setWhitespaces

Methods inherited from class java.lang.Object

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

Constructor Detail

BuilderGenerationHelper

public BuilderGenerationHelper(Writer sourceWriter)

Method Detail

generateBuilderClass

public void generateBuilderClass(String builderObjectSimpleClassName,
                        Collection<VariableElement> requiredFields,
                        Collection<VariableElement> optionalFields,
                        String... interfaces)

generateCustomBuilderConstructor

public void generateCustomBuilderConstructor(String customClassName,
                                    Collection<VariableElement> fieldsToBePassedAndAssigned)

Creates a private object constructor which should only ever be called by the intern Builder class.

Parameters:

customClassName - the object class name

fieldsToBePassedAndAssigned - the fields

generateBuilderBuildMethod

protected void generateBuilderBuildMethod(String builderObjectSimpleClassName)

Helper method to create the Builder#build() method which returns a concrete object instance.

Parameters:

builderObjectSimpleClassName - the object class name

generateBuilderFieldAssignment

protected void generateBuilderFieldAssignment(VariableElement fieldElement,
                                  Object value)

Parameters:

fieldElement -

value -

generateBuilderHeader

protected void generateBuilderHeader()

generateBuilderInvocationMethod

protected void generateBuilderInvocationMethod(VariableElement fieldElement)