Package org.checkerframework.checker.calledmethods.builder

Class LombokSupport

java.lang.Object

org.checkerframework.checker.calledmethods.builder.LombokSupport

All Implemented Interfaces:

BuilderFrameworkSupport

public class LombokSupport
extends Object
implements BuilderFrameworkSupport

Lombok support for the Called Methods Checker. This class adds CalledMethods annotations to the code generated by Lombok.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	NONNULL_ANNOTATIONS	The list of annotations that Lombok treats as non-null.

Constructor Summary

Constructors

Constructor	Description
LombokSupport(CalledMethodsAnnotatedTypeFactory atypeFactory)	Create a new LombokSupport.

Method Summary

Modifier and Type	Method	Description
void	handleBuilderBuildMethod(AnnotatedTypeMirror.AnnotatedExecutableType builderBuildType)	Hook for adding annotations to a build() method (i.e.
void	handleConstructor(NewClassTree tree, AnnotatedTypeMirror type)	Hook for adding annotations (e.g., @CalledMethods) to a constructor call.
void	handleToBuilderMethod(AnnotatedTypeMirror.AnnotatedExecutableType toBuilderType)	Hook for supporting a builder framework's toBuilder routine.
boolean	isBuilderBuildMethod(ExecutableElement candidateBuildElement)	Determines if a method is a build method on a Builder type for the builder framework.
boolean	isToBuilderMethod(ExecutableElement candidateToBuilderElement)	Determines if a method is a toBuilder method on a type generated by the builder framework.

Methods inherited from class java.lang.Object

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

Field Details

NONNULL_ANNOTATIONS

public static final List<String> NONNULL_ANNOTATIONS

The list of annotations that Lombok treats as non-null.

Constructor Details

LombokSupport

public LombokSupport(CalledMethodsAnnotatedTypeFactory atypeFactory)

Create a new LombokSupport.

Parameters:

atypeFactory - the typechecker's type factory

Method Details

isBuilderBuildMethod

public boolean isBuilderBuildMethod(ExecutableElement candidateBuildElement)

Description copied from interface: BuilderFrameworkSupport

Determines if a method is a build method on a Builder type for the builder framework.

Specified by:

isBuilderBuildMethod in interface BuilderFrameworkSupport

Parameters:

candidateBuildElement - a method

Returns:

true if candidateBuildElement is a build method on a Builder type for the builder framework

handleBuilderBuildMethod

public void handleBuilderBuildMethod(AnnotatedTypeMirror.AnnotatedExecutableType builderBuildType)

Description copied from interface: BuilderFrameworkSupport

Hook for adding annotations to a build() method (i.e. a finalizer) generated by a builder framework.

For build methods on Builder types, implementations of this method should determine the required properties and add a corresponding CalledMethods annotation to the type of the receiver parameter.

Specified by:

handleBuilderBuildMethod in interface BuilderFrameworkSupport

Parameters:

builderBuildType - the type of a method that is the build method (as determined by BuilderFrameworkSupport.isBuilderBuildMethod(ExecutableElement)) for a builder

isToBuilderMethod

public boolean isToBuilderMethod(ExecutableElement candidateToBuilderElement)

Description copied from interface: BuilderFrameworkSupport

Determines if a method is a toBuilder method on a type generated by the builder framework.

Specified by:

isToBuilderMethod in interface BuilderFrameworkSupport

Parameters:

candidateToBuilderElement - a method

Returns:

true if candidateToBuilderElement is a toBuilder method on a type generated by the builder framework

handleToBuilderMethod

public void handleToBuilderMethod(AnnotatedTypeMirror.AnnotatedExecutableType toBuilderType)

Description copied from interface: BuilderFrameworkSupport

Hook for supporting a builder framework's toBuilder routine. Typically, the returned Builder has had all of its required setters invoked. So, implementations of this method should add a CalledMethods annotation capturing this fact.

Specified by:

handleToBuilderMethod in interface BuilderFrameworkSupport

Parameters:

toBuilderType - the type of a method that is the toBuilder method (as determined by BuilderFrameworkSupport.isToBuilderMethod(ExecutableElement)) for a type that has an associated builder

handleConstructor

public void handleConstructor(NewClassTree tree,
 AnnotatedTypeMirror type)

Description copied from interface: BuilderFrameworkSupport

Hook for adding annotations (e.g., @CalledMethods) to a constructor call.

Specified by:

handleConstructor in interface BuilderFrameworkSupport

Parameters:

tree - a constructor call

type - type of the call expression