Package org.inferred.freebuilder.processor

Class Analyser

java.lang.Object

org.inferred.freebuilder.processor.Analyser

class Analyser
extends Object

Analyses a FreeBuilder datatype type, returning a GeneratedType for a Builder superclass derived from its API.

Any deviations from the FreeBuilder spec in the user's class will result in errors being issued, but unless code generation is totally impossible, a type will still be returned. This allows the user to extend an existing type without worrying that a mistake will cause compiler errors in all dependent code—which would make it very hard to find the real error.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Analyser.CannotGenerateCodeException	Thrown when a FreeBuilder type cannot have a Builder type generated, for instance if it is private.
private class	Analyser.ConfigImpl
private static final class	Analyser.IsSubclassOfGeneratedTypeVisitor	Visitor that returns true if the visited type extends a generated superclass in the same package.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BUILDER_SIMPLE_NAME_TEMPLATE
private static final SimpleTypeVisitor8<Boolean,?>	CAST_IS_FULLY_CHECKED	Visitor that returns true if a cast to the visited type is guaranteed to be fully checked at runtime.
private final Elements	elements
private final ProcessingEnvironment	env
private static final SimpleTypeVisitor8<Boolean,?>	IS_UNBOUNDED_WILDCARD	Visitor that returns true if the visited type is an unbounded wildcard, i.e.
private final Messager	messager
private final Types	types
private static final String	USER_BUILDER_NAME

Constructor Summary

Constructors

Constructor	Description
Analyser(ProcessingEnvironment env, Messager messager)

Method Summary

Modifier and Type	Method	Description
private void	addPropertyData(Property.Builder propertyBuilder, TypeElement valueType, ExecutableElement method, Optional<JacksonSupport> jacksonSupport)	Introspects method, as found on valueType.
(package private) GeneratedType	analyse(TypeElement type)	Returns a Builder GeneratedType for type.
private static String	camelCaseToAllCaps(String camelCase)	Converts camelCaseConvention to ALL_CAPS_CONVENTION.
private Datatype.Builder	constructionAndExtension(DeclaredType builder)
private static PropertyCodeGenerator	createCodeGenerator(PropertyCodeGenerator.Config config)
private Map<Datatype.StandardMethod,Datatype.UnderrideLevel>	findUnderriddenMethods(Iterable<ExecutableElement> methods)	Find any standard methods the user has 'underridden' in their type.
private String	generatedBuilderSimpleName(TypeElement type)	Returns the simple name of the builder class that should be generated for the given type.
private Set<String>	getMethodsInvokedInBuilderConstructor(TypeElement builder)
private boolean	hasToBuilderMethod(DeclaredType builder, boolean isExtensible, Iterable<ExecutableElement> methods)	Find a toBuilder method, if the user has provided one.
private Predicate<TypeMirror>	isEqualTo(Class<?> cls)
private boolean	isToBuilderMethod(DeclaredType declaredType, ExecutableElement method)
private static boolean	isUnderride(ExecutableElement method)
private static Optional<Datatype.StandardMethod>	maybeStandardMethod(ExecutableElement method)	Returns whether a method is one of the Datatype.StandardMethods, and if so, which.
private Map<Property,PropertyCodeGenerator>	pickPropertyGenerators(TypeElement type, Datatype datatype, DeclaredType builder, Iterable<ExecutableElement> methods)
private Set<ExecutableElement>	removeNonGetterMethods(DeclaredType builder, Iterable<ExecutableElement> methods)
private boolean	shouldBuilderBeSerializable(DeclaredType builder)
private Optional<DeclaredType>	tryFindBuilder(QualifiedName superclass, TypeElement valueType)	Looks for a nested type in valueType called Builder, and verifies it extends the autogenerated superclass.
private void	verifyType(TypeElement type, PackageElement pkg)	Basic sanity-checking to ensure we can fulfil the @FreeBuilder contract for this type.
private void	verifyTypeIsConstructible(TypeElement type)	Issues an error if type does not have a package-visible no-args constructor.

Methods inherited from class java.lang.Object

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

Field Details

BUILDER_SIMPLE_NAME_TEMPLATE

private static final String BUILDER_SIMPLE_NAME_TEMPLATE

See Also:

• Constant Field Values

USER_BUILDER_NAME

private static final String USER_BUILDER_NAME

See Also:

• Constant Field Values

env

private final ProcessingEnvironment env

elements

private final Elements elements

messager

private final Messager messager

types

private final Types types

CAST_IS_FULLY_CHECKED

private static final SimpleTypeVisitor8<Boolean,?> CAST_IS_FULLY_CHECKED

Visitor that returns true if a cast to the visited type is guaranteed to be fully checked at runtime. This is true for any type that is non-generic, raw, or parameterized with unbounded wildcards, such as Integer, List or Map<?, ?>.

IS_UNBOUNDED_WILDCARD

private static final SimpleTypeVisitor8<Boolean,?> IS_UNBOUNDED_WILDCARD

Visitor that returns true if the visited type is an unbounded wildcard, i.e. <?>.

Constructor Details

Analyser

Analyser(ProcessingEnvironment env,
 Messager messager)

Method Details

analyse

GeneratedType analyse(TypeElement type)
               throws Analyser.CannotGenerateCodeException

Returns a Builder GeneratedType for type.

Throws:

Analyser.CannotGenerateCodeException - if code cannot be generated, e.g. if the type is private

verifyType

private void verifyType(TypeElement type,
 PackageElement pkg)
                 throws Analyser.CannotGenerateCodeException

Basic sanity-checking to ensure we can fulfil the @FreeBuilder contract for this type.

Throws:

Analyser.CannotGenerateCodeException

verifyTypeIsConstructible

private void verifyTypeIsConstructible(TypeElement type)
                                throws Analyser.CannotGenerateCodeException

Issues an error if type does not have a package-visible no-args constructor.

Throws:

Analyser.CannotGenerateCodeException

findUnderriddenMethods

private Map<Datatype.StandardMethod,Datatype.UnderrideLevel> findUnderriddenMethods(Iterable<ExecutableElement> methods)

Find any standard methods the user has 'underridden' in their type.

hasToBuilderMethod

private boolean hasToBuilderMethod(DeclaredType builder,
 boolean isExtensible,
 Iterable<ExecutableElement> methods)

Find a toBuilder method, if the user has provided one.

isToBuilderMethod

private boolean isToBuilderMethod(DeclaredType declaredType,
 ExecutableElement method)

removeNonGetterMethods

private Set<ExecutableElement> removeNonGetterMethods(DeclaredType builder,
 Iterable<ExecutableElement> methods)

isUnderride

private static boolean isUnderride(ExecutableElement method)

tryFindBuilder

private Optional<DeclaredType> tryFindBuilder(QualifiedName superclass,
 TypeElement valueType)

Looks for a nested type in valueType called Builder, and verifies it extends the autogenerated superclass.

If the value type is generic, the builder type must match, and the returned DeclaredType will be parameterized with the type variables from the value type, not the builder. (This makes type checking massively easier.)

Issues an error if the wrong type is being subclassed—a typical copy-and-paste error when renaming an existing @FreeBuilder type, or using one as a template.

constructionAndExtension

private Datatype.Builder constructionAndExtension(DeclaredType builder)

pickPropertyGenerators

private Map<Property,PropertyCodeGenerator> pickPropertyGenerators(TypeElement type,
 Datatype datatype,
 DeclaredType builder,
 Iterable<ExecutableElement> methods)

getMethodsInvokedInBuilderConstructor

private Set<String> getMethodsInvokedInBuilderConstructor(TypeElement builder)

addPropertyData

private void addPropertyData(Property.Builder propertyBuilder,
 TypeElement valueType,
 ExecutableElement method,
 Optional<JacksonSupport> jacksonSupport)

Introspects method, as found on valueType.

createCodeGenerator

private static PropertyCodeGenerator createCodeGenerator(PropertyCodeGenerator.Config config)

generatedBuilderSimpleName

private String generatedBuilderSimpleName(TypeElement type)

Returns the simple name of the builder class that should be generated for the given type.

This is simply the BUILDER_SIMPLE_NAME_TEMPLATE with the original type name substituted in. (If the original type is nested, its enclosing classes will be included, separated with underscores, to ensure uniqueness.)

shouldBuilderBeSerializable

private boolean shouldBuilderBeSerializable(DeclaredType builder)

maybeStandardMethod

private static Optional<Datatype.StandardMethod> maybeStandardMethod(ExecutableElement method)

Returns whether a method is one of the Datatype.StandardMethods, and if so, which.

camelCaseToAllCaps

private static String camelCaseToAllCaps(String camelCase)

Converts camelCaseConvention to ALL_CAPS_CONVENTION.

isEqualTo

private Predicate<TypeMirror> isEqualTo(Class<?> cls)