org.mapstruct.ap.internal.model

Class MethodReference

java.lang.Object

org.mapstruct.ap.internal.writer.FreeMarkerWritable

org.mapstruct.ap.internal.model.common.ModelElement

org.mapstruct.ap.internal.model.MethodReference

All Implemented Interfaces:

Assignment, Writable

Direct Known Subclasses:

LifecycleCallbackMethodReference

public class MethodReference
extends ModelElement
implements Assignment

Represents a reference to another method, e.g. used to map a bean property from source to target type or to instantiate the return value of a mapping method (rather than calling the new operator).

Author:

Gunnar Morling

Nested Class Summary

Nested classes/interfaces inherited from interface org.mapstruct.ap.internal.model.common.Assignment

Assignment.AssignmentType

Nested classes/interfaces inherited from interface org.mapstruct.ap.internal.writer.Writable

Writable.Context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MethodReference(Method method, MapperReference declaringMapper, Parameter providingParameter, List<ParameterBinding> parameterBindings) Creates a new reference to the given method.

Method Summary

Modifier and Type	Method and Description
String	createUniqueVarName(String desiredName) Creates an unique safe (local) variable name.
boolean	equals(Object obj)
static MethodReference	forBuiltInMethod(BuiltInMethod method, ConversionContext contextParam)
static MethodReference	forConstructorInvocation(Type type, List<ParameterBinding> parameterBindings)
static MethodReference	forForgedMethod(Method method, List<ParameterBinding> parameterBindings)
static MethodReference	forMapperReference(Method method, MapperReference declaringMapper, List<ParameterBinding> parameterBindings)
static MethodReference	forMethodCall(String methodName)
static MethodReference	forParameterProvidedMethod(Method method, Parameter providingParameter, List<ParameterBinding> parameterBindings)
static MethodReference	forStaticBuilder(String builderCreationMethod, Type definingType)
Assignment	getAssignment()
String	getContextParam()
MapperReference	getDeclaringMapper()
Type	getDefiningType()
Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
String	getMapperVariableName()
String	getName()
List<ParameterBinding>	getParameterBindings()
Parameter	getProvidingParameter()
Type	getReturnType()
Type	getSingleSourceParameterType()
String	getSourceLocalVarName() See Assignment.setSourceLocalVarName(java.lang.String)
String	getSourceLoopVarName() See Assignment.getSourceLoopVarName() (java.lang.String) }
String	getSourceParameterName() Returns the source parameter name, to which this assignment applies.
List<Parameter>	getSourceParameters()
String	getSourcePresenceCheckerReference() the source presence checker reference
String	getSourceReference() the source reference being a source-getter, a constant, nested method call, etc.
Type	getSourceType() the source type used in the matching process
List<Type>	getThrownTypes() returns all types exception types thrown by this assignment.
Assignment.AssignmentType	getType() Returns whether the type of assignment
int	hashCode()
Type	inferTypeWhenEnum(Type type)
boolean	isCallingUpdateMethod()
boolean	isConstructor()
boolean	isSourceReferenceParameter()
boolean	isStatic()
void	setAssignment(Assignment assignment) An assignment in itself can wrap another assignment.
void	setSourceLocalVarName(String sourceLocalVarName) Replaces the sourceReference at the call site in the assignment in the template with this sourceLocalVarName.
void	setSourceLoopVarName(String sourceLoopVarName) Replaces the sourceLocalVar or sourceReference at the call site in the assignment in the template with this sourceLoopVarName.
String	toString()

Methods inherited from class org.mapstruct.ap.internal.writer.FreeMarkerWritable

getTemplateName, getTemplateNameForClass, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodReference

protected MethodReference(Method method,
                          MapperReference declaringMapper,
                          Parameter providingParameter,
                          List<ParameterBinding> parameterBindings)

Creates a new reference to the given method.

Parameters:

method - the target method of the reference

declaringMapper - the method declaring the mapper; null if the current mapper itself

providingParameter - The parameter providing the mapper, or null if the method is defined by the mapper itself or by declaringMapper.

parameterBindings - the parameter bindings of this method reference

Method Detail

getDeclaringMapper

public MapperReference getDeclaringMapper()

getProvidingParameter

public Parameter getProvidingParameter()

getMapperVariableName

public String getMapperVariableName()

getContextParam

public String getContextParam()

getAssignment

public Assignment getAssignment()

getName

public String getName()

getSourceParameters

public List<Parameter> getSourceParameters()

setAssignment

public void setAssignment(Assignment assignment)

Description copied from interface: Assignment

An assignment in itself can wrap another assignment. E.g.:

• a MethodReference can wrap a TypeConversion, another MethodReference and ultimately a Simple
• a TypeConversion can wrap a MethodReference, and ultimately a Simple

Specified by:

setAssignment in interface Assignment

Parameters:

assignment - the assignment to set

getSourceReference

public String getSourceReference()

Description copied from interface: Assignment

the source reference being a source-getter, a constant, nested method call, etc.

Specified by:

getSourceReference in interface Assignment

Returns:

source reference

getSourcePresenceCheckerReference

public String getSourcePresenceCheckerReference()

Description copied from interface: Assignment

the source presence checker reference

Specified by:

getSourcePresenceCheckerReference in interface Assignment

Returns:

source reference

getSourceType

public Type getSourceType()

Description copied from interface: Assignment

the source type used in the matching process

Specified by:

getSourceType in interface Assignment

Returns:

source type (can be null)

createUniqueVarName

public String createUniqueVarName(String desiredName)

Description copied from interface: Assignment

Creates an unique safe (local) variable name.

Specified by:

createUniqueVarName in interface Assignment

Parameters:

desiredName - the desired name

Returns:

the desired name, made unique in the scope of the bean mapping.

getSourceLocalVarName

public String getSourceLocalVarName()

Description copied from interface: Assignment

See Assignment.setSourceLocalVarName(java.lang.String)

Specified by:

getSourceLocalVarName in interface Assignment

Returns:

local variable name (can be null if not set)

setSourceLocalVarName

public void setSourceLocalVarName(String sourceLocalVarName)

Description copied from interface: Assignment

Replaces the sourceReference at the call site in the assignment in the template with this sourceLocalVarName. The sourceLocalVarName can subsequently be used for e.g. null checking.

Specified by:

setSourceLocalVarName in interface Assignment

Parameters:

sourceLocalVarName - source local variable name

getSourceLoopVarName

public String getSourceLoopVarName()

Description copied from interface: Assignment

See Assignment.getSourceLoopVarName() (java.lang.String) }

Specified by:

getSourceLoopVarName in interface Assignment

Returns:

loop variable (can be null if not set)

setSourceLoopVarName

public void setSourceLoopVarName(String sourceLoopVarName)

Description copied from interface: Assignment

Replaces the sourceLocalVar or sourceReference at the call site in the assignment in the template with this sourceLoopVarName. The sourceLocalVar can subsequently be used for e.g. null checking.

Specified by:

setSourceLoopVarName in interface Assignment

Parameters:

sourceLoopVarName - loop variable

getSourceParameterName

public String getSourceParameterName()

Description copied from interface: Assignment

Returns the source parameter name, to which this assignment applies. Note: the source parameter itself might be mapped by this assignment, or one of its properties

Specified by:

getSourceParameterName in interface Assignment

Returns:

the source parameter name

isSourceReferenceParameter

public boolean isSourceReferenceParameter()

Specified by:

isSourceReferenceParameter in interface Assignment

Returns:

true when the source reference is the source parameter (and not a property of the source parameter type)

getSingleSourceParameterType

public Type getSingleSourceParameterType()

Returns:

the type of the single source parameter that is not the @TargetType parameter

getDefiningType

public Type getDefiningType()

getImportTypes

public Set<Type> getImportTypes()

Description copied from class: ModelElement

Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.

Specified by:

getImportTypes in interface Assignment

Specified by:

getImportTypes in class ModelElement

Returns:

A set with type referenced by this model element. Must not be null.

getThrownTypes

public List<Type> getThrownTypes()

Description copied from interface: Assignment

returns all types exception types thrown by this assignment.

Specified by:

getThrownTypes in interface Assignment

Returns:

exceptions thrown

getType

public Assignment.AssignmentType getType()

Description copied from interface: Assignment

Returns whether the type of assignment

Specified by:

getType in interface Assignment

Returns:

Assignment.AssignmentType

getReturnType

public Type getReturnType()

isCallingUpdateMethod

public boolean isCallingUpdateMethod()

Specified by:

isCallingUpdateMethod in interface Assignment

isStatic

public boolean isStatic()

isConstructor

public boolean isConstructor()

getParameterBindings

public List<ParameterBinding> getParameterBindings()

inferTypeWhenEnum

public Type inferTypeWhenEnum(Type type)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

forBuiltInMethod

public static MethodReference forBuiltInMethod(BuiltInMethod method,
                                               ConversionContext contextParam)

forForgedMethod

public static MethodReference forForgedMethod(Method method,
                                              List<ParameterBinding> parameterBindings)

forParameterProvidedMethod

public static MethodReference forParameterProvidedMethod(Method method,
                                                         Parameter providingParameter,
                                                         List<ParameterBinding> parameterBindings)

forMapperReference

public static MethodReference forMapperReference(Method method,
                                                 MapperReference declaringMapper,
                                                 List<ParameterBinding> parameterBindings)

forStaticBuilder

public static MethodReference forStaticBuilder(String builderCreationMethod,
                                               Type definingType)

forMethodCall

public static MethodReference forMethodCall(String methodName)

forConstructorInvocation

public static MethodReference forConstructorInvocation(Type type,
                                                       List<ParameterBinding> parameterBindings)

toString

public String toString()

Overrides:

toString in class Object