org.mapstruct.ap.model

Class MethodReference

java.lang.Object

org.mapstruct.ap.writer.FreeMarkerWritable

org.mapstruct.ap.model.common.ModelElement

org.mapstruct.ap.model.MappingMethod

org.mapstruct.ap.model.MethodReference

All Implemented Interfaces:

Assignment, Writable

public class MethodReference
extends MappingMethod
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.model.assignment.Assignment

Assignment.AssignmentType

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

Writable.Context

Constructor Summary

Constructors

Constructor and Description
MethodReference(BuiltInMethod method, ConversionContext contextParam)
MethodReference(Method method, MapperReference declaringMapper, Type targetType) Creates a new reference to the given method.

Method Summary

Modifier and Type	Method and Description
Assignment	getAssignment()
String	getContextParam()
MapperReference	getDeclaringMapper()
List<Type>	getExceptionTypes() returns all types exception types thrown by this assignment.
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()
Type	getSingleSourceParameterType()
String	getSourceReference() the source reference being a source-getter, a constant, etc.
Assignment.AssignmentType	getType() Returns whether the type of assignment
boolean	isUpdateMethod()
void	setAssignment(Assignment assignment) An assignment in itself can wrap another assignment.

Methods inherited from class org.mapstruct.ap.model.MappingMethod

getAccessibility, getName, getParameterNames, getParameters, getResultName, getResultType, getReturnType, getSourceParameters, getThrownTypes, isExistingInstanceMapping, isStatic, toString

Methods inherited from class org.mapstruct.ap.model.common.ModelElement

write

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

getTemplateName

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodReference

public MethodReference(Method method,
                       MapperReference declaringMapper,
                       Type targetType)

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

targetType - in case the referenced method has a parameter for passing the target type, the given target type, otherwise null

MethodReference

public MethodReference(BuiltInMethod method,
                       ConversionContext contextParam)

Method Detail

getDeclaringMapper

public MapperReference getDeclaringMapper()

getMapperVariableName

public String getMapperVariableName()

getContextParam

public String getContextParam()

getAssignment

public Assignment getAssignment()

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

getSourceReference

public String getSourceReference()

Description copied from interface: Assignment

the source reference being a source-getter, a constant, etc.

Specified by:

getSourceReference in interface Assignment

Returns:

source reference

getSingleSourceParameterType

public Type getSingleSourceParameterType()

Returns:

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

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

Overrides:

getImportTypes in class MappingMethod

Returns:

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

getExceptionTypes

public List<Type> getExceptionTypes()

Description copied from interface: Assignment

returns all types exception types thrown by this assignment.

Specified by:

getExceptionTypes 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

isUpdateMethod

public boolean isUpdateMethod()

Specified by:

isUpdateMethod in interface Assignment