io.sphere.sdk.annotations.processors.generators

Class HasBuilderGenerator

java.lang.Object

io.sphere.sdk.annotations.processors.generators.HasBuilderGenerator

public class HasBuilderGenerator
extends Object

Generates builders for interfaces annotated with HasBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<A>	annotationType
protected Elements	elements
protected Messager	messager
protected Types	types
protected TypeUtils	typeUtils

Constructor Summary

Constructors

Constructor and Description
HasBuilderGenerator(Elements elements, Types types, Messager messager)

Method Summary

Modifier and Type	Method and Description
protected com.squareup.javapoet.MethodSpec.Builder	addBuilderMethodReturn(TypeElement builderType, com.squareup.javapoet.MethodSpec.Builder builder) Adds the return statement for the builder method.
protected void	addSuppressWarnings(com.squareup.javapoet.MethodSpec.Builder builder)
protected void	copyDeprecatedAnnotation(PropertyGenModel property, com.squareup.javapoet.MethodSpec.Builder methodSpecBuilder)
protected void	copyDeprecatedAnnotation(PropertyGenModel property, com.squareup.javapoet.TypeSpec.Builder typeSpecBuilder)
protected void	copyJsonAnnotation(PropertyGenModel property, com.squareup.javapoet.MethodSpec.Builder builder)
protected List<com.squareup.javapoet.MethodSpec>	createBuilderMethods(TypeElement returnType, PropertyGenModel property) Creates a builder method for the given getter method.
protected com.squareup.javapoet.MethodSpec	createBuildMethod(com.squareup.javapoet.TypeName returnType, com.squareup.javapoet.TypeName implType, List<ExecutableElement> propertyMethods)
protected com.squareup.javapoet.MethodSpec	createConstructor(List<PropertyGenModel> properties)
protected com.squareup.javapoet.MethodSpec	createConstructor(List<PropertyGenModel> properties, List<Modifier> modifiers)
protected com.squareup.javapoet.MethodSpec	createCopyFactoryMethod(TypeElement typeElement, com.squareup.javapoet.ClassName returnType, List<ExecutableElement> propertyMethods)
protected com.squareup.javapoet.MethodSpec	createCopyFactoryMethod(TypeElement typeElement, com.squareup.javapoet.ClassName returnType, List<ExecutableElement> propertyMethods, List<PropertyGenModel> propertyGenModels)
protected com.squareup.javapoet.MethodSpec	createDefaultConstructor(List<Modifier> modifiers)
protected com.squareup.javapoet.MethodSpec	createFactoryMethod(FactoryMethod factoryMethod, List<PropertyGenModel> properties, com.squareup.javapoet.ClassName returnType)
protected com.squareup.javapoet.MethodSpec	createFactoryMethod(List<PropertyGenModel> properties, com.squareup.javapoet.ClassName returnType, List<String> parameterNames, String methodName, boolean useLowercaseBooleans)
protected List<com.squareup.javapoet.MethodSpec>	createFactoryMethods(FactoryMethod[] factoryMethods, List<PropertyGenModel> properties, com.squareup.javapoet.ClassName returnType)
protected com.squareup.javapoet.FieldSpec	createField(PropertyGenModel property)
protected com.squareup.javapoet.FieldSpec	createField(PropertyGenModel property, List<Modifier> modifiers)
protected com.squareup.javapoet.FieldSpec	createField(PropertyGenModel property, Modifier modifier)
protected com.squareup.javapoet.FieldSpec.Builder	createFieldBuilder(PropertyGenModel property, Modifier modifier)
protected com.squareup.javapoet.MethodSpec	createGetMethod(PropertyGenModel property)
protected com.squareup.javapoet.AnnotationSpec	createJsonPropertyAnnotation(String jsonName)
protected com.squareup.javapoet.ParameterSpec	createParameter(PropertyGenModel property, boolean useLowercaseBooleans, boolean copyNullable)
protected com.squareup.javapoet.ParameterSpec	createParameter(PropertyGenModel property, com.squareup.javapoet.TypeName parameterType, boolean copyNullable)
protected List<com.squareup.javapoet.ParameterSpec>	createParameters(List<PropertyGenModel> properties, boolean useLowercaseBooleans, boolean copyNullable)
protected String	escapeJavaKeyword(String name) Escapes the given name with an "_" if it's a java keyword (e.g.
com.squareup.javapoet.JavaFile	generate(T annotatedElement) Generates code for the given annotated type element.
com.squareup.javapoet.TypeSpec	generateType(TypeElement builderType)
protected List<ExecutableElement>	getAllPropertyMethodsSorted(TypeElement typeElement) Returns all property methods - including inherited methods - sorted by their property name.
protected A	getAnnotationValue(TypeElement typeElement) Returns the annotation value from the given type element used by this generator.
protected String	getPackageName(Element element)
protected List<PropertyGenModel>	getPropertyGenModels(List<ExecutableElement> propertyMethods)
protected List<ExecutableElement>	getPropertyMethodsSorted(TypeElement typeElement) Returns property methods - not included inherited methods - sorted by their property name.

Methods inherited from class java.lang.Object

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

Field Detail

annotationType

protected final Class<A extends Annotation> annotationType

elements

protected final Elements elements

types

protected final Types types

messager

protected final Messager messager

typeUtils

protected final TypeUtils typeUtils

Constructor Detail

HasBuilderGenerator

public HasBuilderGenerator(Elements elements,
                           Types types,
                           Messager messager)

Method Detail

generateType

public com.squareup.javapoet.TypeSpec generateType(TypeElement builderType)

addBuilderMethodReturn

protected com.squareup.javapoet.MethodSpec.Builder addBuilderMethodReturn(TypeElement builderType,
                                                                          com.squareup.javapoet.MethodSpec.Builder builder)

Adds the return statement for the builder method.

Parameters:

builderType - the builder type

builder - the builder to add the return statement

Returns:

the builder with the added return statement

getAnnotationValue

protected A getAnnotationValue(TypeElement typeElement)

Returns the annotation value from the given type element used by this generator.

Parameters:

typeElement -

Returns:

createBuildMethod

protected com.squareup.javapoet.MethodSpec createBuildMethod(com.squareup.javapoet.TypeName returnType,
                                                             com.squareup.javapoet.TypeName implType,
                                                             List<ExecutableElement> propertyMethods)

createBuilderMethods

protected List<com.squareup.javapoet.MethodSpec> createBuilderMethods(TypeElement returnType,
                                                                      PropertyGenModel property)

Creates a builder method for the given getter method.

Parameters:

property - the getter method

returnType - the returned type from the builder

Returns:

a list of builder methods - this will allow us later to create additional builder methods for collection types

generate

public final com.squareup.javapoet.JavaFile generate(T annotatedElement)

Generates code for the given annotated type element.

Parameters:

annotatedElement - the annotated type element

Returns:

the java file to write

createField

protected com.squareup.javapoet.FieldSpec createField(PropertyGenModel property)

createField

protected com.squareup.javapoet.FieldSpec createField(PropertyGenModel property,
                                                      Modifier modifier)

createFieldBuilder

protected com.squareup.javapoet.FieldSpec.Builder createFieldBuilder(PropertyGenModel property,
                                                                     Modifier modifier)

escapeJavaKeyword

protected String escapeJavaKeyword(String name)

Escapes the given name with an "_" if it's a java keyword (e.g. default.

Parameters:

name - the name to escape

Returns:

the escaped name

getAllPropertyMethodsSorted

protected List<ExecutableElement> getAllPropertyMethodsSorted(TypeElement typeElement)

Returns all property methods - including inherited methods - sorted by their property name.

Parameters:

typeElement - the type element

Returns:

methods sorted by their PropertyGenModel.getPropertyName(ExecutableElement)

getPropertyMethodsSorted

protected List<ExecutableElement> getPropertyMethodsSorted(TypeElement typeElement)

Returns property methods - not included inherited methods - sorted by their property name.

Parameters:

typeElement - the type element

Returns:

methods sorted by their PropertyGenModel.getPropertyName(ExecutableElement)

getPropertyGenModels

protected List<PropertyGenModel> getPropertyGenModels(List<ExecutableElement> propertyMethods)

createGetMethod

protected com.squareup.javapoet.MethodSpec createGetMethod(PropertyGenModel property)

copyJsonAnnotation

protected void copyJsonAnnotation(PropertyGenModel property,
                                  com.squareup.javapoet.MethodSpec.Builder builder)

getPackageName

protected String getPackageName(Element element)

addSuppressWarnings

protected void addSuppressWarnings(com.squareup.javapoet.MethodSpec.Builder builder)

copyDeprecatedAnnotation

protected void copyDeprecatedAnnotation(PropertyGenModel property,
                                        com.squareup.javapoet.TypeSpec.Builder typeSpecBuilder)

copyDeprecatedAnnotation

protected void copyDeprecatedAnnotation(PropertyGenModel property,
                                        com.squareup.javapoet.MethodSpec.Builder methodSpecBuilder)

createParameter

protected com.squareup.javapoet.ParameterSpec createParameter(PropertyGenModel property,
                                                              boolean useLowercaseBooleans,
                                                              boolean copyNullable)

Parameters:

property - the property to generate the parameter

useLowercaseBooleans - FactoryMethod.useLowercaseBooleans()

copyNullable - if true, an existing Nullable annotation on the model will be copied to the parameter

Returns:

createParameter

protected com.squareup.javapoet.ParameterSpec createParameter(PropertyGenModel property,
                                                              com.squareup.javapoet.TypeName parameterType,
                                                              boolean copyNullable)

createField

protected com.squareup.javapoet.FieldSpec createField(PropertyGenModel property,
                                                      List<Modifier> modifiers)

createDefaultConstructor

protected com.squareup.javapoet.MethodSpec createDefaultConstructor(List<Modifier> modifiers)

createConstructor

protected com.squareup.javapoet.MethodSpec createConstructor(List<PropertyGenModel> properties,
                                                             List<Modifier> modifiers)

createParameters

protected List<com.squareup.javapoet.ParameterSpec> createParameters(List<PropertyGenModel> properties,
                                                                     boolean useLowercaseBooleans,
                                                                     boolean copyNullable)

createConstructor

protected com.squareup.javapoet.MethodSpec createConstructor(List<PropertyGenModel> properties)

createJsonPropertyAnnotation

protected com.squareup.javapoet.AnnotationSpec createJsonPropertyAnnotation(String jsonName)

createFactoryMethods

protected List<com.squareup.javapoet.MethodSpec> createFactoryMethods(FactoryMethod[] factoryMethods,
                                                                      List<PropertyGenModel> properties,
                                                                      com.squareup.javapoet.ClassName returnType)

createFactoryMethod

protected com.squareup.javapoet.MethodSpec createFactoryMethod(FactoryMethod factoryMethod,
                                                               List<PropertyGenModel> properties,
                                                               com.squareup.javapoet.ClassName returnType)

createFactoryMethod

protected com.squareup.javapoet.MethodSpec createFactoryMethod(List<PropertyGenModel> properties,
                                                               com.squareup.javapoet.ClassName returnType,
                                                               List<String> parameterNames,
                                                               String methodName,
                                                               boolean useLowercaseBooleans)

createCopyFactoryMethod

protected com.squareup.javapoet.MethodSpec createCopyFactoryMethod(TypeElement typeElement,
                                                                   com.squareup.javapoet.ClassName returnType,
                                                                   List<ExecutableElement> propertyMethods)

createCopyFactoryMethod

protected com.squareup.javapoet.MethodSpec createCopyFactoryMethod(TypeElement typeElement,
                                                                   com.squareup.javapoet.ClassName returnType,
                                                                   List<ExecutableElement> propertyMethods,
                                                                   List<PropertyGenModel> propertyGenModels)