Class FunctionalType

java.lang.Object

org.inferred.freebuilder.processor.source.ValueType

org.inferred.freebuilder.processor.source.FunctionalType

public class FunctionalType
extends ValueType

Metadata about a functional interface.

Nested Class Summary

Nested classes/interfaces inherited from class ValueType

ValueType.FieldReceiver

Field Summary

Fields

Modifier and Type	Field	Description
private final Type	functionalInterface
private final String	methodName
private final List<TypeMirror>	parameters
private final TypeMirror	returnType

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FunctionalType(Type functionalInterface, String methodName, Collection<? extends TypeMirror> parameters, TypeMirror returnType)

Method Summary

Modifier and Type	Method	Description
protected void	addFields(ValueType.FieldReceiver fields)	Implement this method to report the name and value of each field.
boolean	canReturnNull()
static FunctionalType	consumer(TypeMirror type)	Returns Consumer<type>.
static FunctionalType	functionalTypeAcceptedByMethod(DeclaredType type, String methodName, FunctionalType prototype, Elements elements, Types types)	Returns the functional type accepted by methodName on type, assignable to prototype, or prototype itself if no such method has been declared.
static List<FunctionalType>	functionalTypesAcceptedByMethod(DeclaredType type, String methodName, Elements elements, Types types)	Returns the functional types accepted by methodName on type.
Type	getFunctionalInterface()
String	getMethodName()
List<TypeMirror>	getParameters()
TypeMirror	getReturnType()
private static boolean	isAssignable(TypeMirror fromParam, TypeMirror toParam, Types types)
static boolean	isAssignable(FunctionalType fromType, FunctionalType toType, Types types)
private static boolean	isVoid(TypeMirror type)
static Optional<FunctionalType>	maybeFunctionalType(DeclaredType type, Elements elements, Types types)
static Optional<FunctionalType>	maybeFunctionalType(TypeMirror type, Elements elements, Types types)
static FunctionalType	primitiveUnaryOperator(PrimitiveType type)	Returns one of IntUnaryOperator, LongUnaryOperator or DoubleUnaryOperator, depending on type.
String	toString()
static FunctionalType	unaryOperator(TypeMirror type)	Returns UnaryOperator<type>.
static FunctionalType	unboxedUnaryOperator(TypeMirror type, Types types)	Returns a unary operator that will accept type, without autoboxing if possible.

Methods inherited from class ValueType

equals, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

functionalInterface

private final Type functionalInterface

methodName

private final String methodName

parameters

private final List<TypeMirror> parameters

returnType

private final TypeMirror returnType

Constructor Details

FunctionalType

private FunctionalType(Type functionalInterface,
 String methodName,
 Collection<? extends TypeMirror> parameters,
 TypeMirror returnType)

Method Details

consumer

public static FunctionalType consumer(TypeMirror type)

Returns Consumer<type>.

Throws:

IllegalArgumentException - if type is primitive

unaryOperator

public static FunctionalType unaryOperator(TypeMirror type)

Returns UnaryOperator<type>.

Throws:

IllegalArgumentException - if type is primitive

primitiveUnaryOperator

public static FunctionalType primitiveUnaryOperator(PrimitiveType type)

Returns one of IntUnaryOperator, LongUnaryOperator or DoubleUnaryOperator, depending on type.

Throws:

IllegalArgumentException - if type is not one of int, long or double

unboxedUnaryOperator

public static FunctionalType unboxedUnaryOperator(TypeMirror type,
 Types types)

Returns a unary operator that will accept type, without autoboxing if possible.

functionalTypeAcceptedByMethod

public static FunctionalType functionalTypeAcceptedByMethod(DeclaredType type,
 String methodName,
 FunctionalType prototype,
 Elements elements,
 Types types)

Returns the functional type accepted by methodName on type, assignable to prototype, or prototype itself if no such method has been declared.

Used to allow the user to override the functional interface used on builder methods, e.g. to force boxing, or to use Guava types.

functionalTypesAcceptedByMethod

public static List<FunctionalType> functionalTypesAcceptedByMethod(DeclaredType type,
 String methodName,
 Elements elements,
 Types types)

Returns the functional types accepted by methodName on type.

maybeFunctionalType

public static Optional<FunctionalType> maybeFunctionalType(TypeMirror type,
 Elements elements,
 Types types)

maybeFunctionalType

public static Optional<FunctionalType> maybeFunctionalType(DeclaredType type,
 Elements elements,
 Types types)

isAssignable

public static boolean isAssignable(FunctionalType fromType,
 FunctionalType toType,
 Types types)

isAssignable

private static boolean isAssignable(TypeMirror fromParam,
 TypeMirror toParam,
 Types types)

isVoid

private static boolean isVoid(TypeMirror type)

getFunctionalInterface

public Type getFunctionalInterface()

getMethodName

public String getMethodName()

getParameters

public List<TypeMirror> getParameters()

getReturnType

public TypeMirror getReturnType()

canReturnNull

public boolean canReturnNull()

addFields

protected void addFields(ValueType.FieldReceiver fields)

Description copied from class: ValueType

Implement this method to report the name and value of each field.

Specified by:

addFields in class ValueType

toString

public String toString()

Overrides:

toString in class ValueType