org.mapstruct.ap.model.source

Class SourceMethod

java.lang.Object

org.mapstruct.ap.model.source.SourceMethod

All Implemented Interfaces:

Method

public class SourceMethod
extends Object
implements Method

Represents a mapping method with source and target type and the mappings between the properties of source and target type.

A method can either be configured by itself or by another method for the inverse mapping direction (one of setMappings(Map), setIterableMapping(IterableMapping) or setMapMapping(MapMapping) will be called in this case).

Author:

Gunnar Morling

Method Summary

Modifier and Type	Method and Description
static boolean	containsTargetTypeParameter(List<Parameter> parameters)
static SourceMethod	forFactoryMethod(Type declaringMapper, ExecutableElement executable, Type returnType, List<Type> exceptionTypes, Types typeUtils)
static SourceMethod	forMethodRequiringImplementation(ExecutableElement executable, List<Parameter> parameters, Type returnType, List<Type> exceptionTypes, Map<String,List<Mapping>> mappings, IterableMapping iterableMapping, MapMapping mapMapping, Types typeUtils, Messager messager, TypeFactory typeFactory)
static SourceMethod	forReferencedMethod(Type declaringMapper, ExecutableElement executable, List<Parameter> parameters, Type returnType, List<Type> exceptionTypes, Types typeUtils)
Accessibility	getAccessibility() Returns the Accessibility of this method.
Type	getDeclaringMapper() Returns the mapper type declaring this method if it is not declared by the mapper interface currently processed but by another mapper imported via Mapper#users().
ExecutableElement	getExecutable()
IterableMapping	getIterableMapping()
MapMapping	getMapMapping()
List<Mapping>	getMappingBySourcePropertyName(String sourcePropertyName) Returns the Mappings for the given source property.
Map<String,List<Mapping>>	getMappings()
String	getName() Returns then name of the method.
List<String>	getParameterNames()
List<Parameter>	getParameters() In contrast to Method.getSourceParameters() this method returns all parameters
Type	getResultType() Returns the type of the result.
Type	getReturnType() Returns the return type of the method
Mapping	getSingleMappingByTargetPropertyName(String targetPropertyName)
Parameter	getSourceParameter(String sourceParameterName)
List<Parameter>	getSourceParameters() returns the list of 'true' source parameters excluding the parameter(s) that is designated as target by means of the target annotation Method.getTargetParameter().
Parameter	getTargetParameter() Returns the parameter designated as target parameter (if present) Method.getSourceParameters()
List<Type>	getThrownTypes() Returns all exceptions thrown by this method
boolean	isEnumMapping()
boolean	isIterableMapping()
boolean	isMapMapping()
boolean	matches(List<Type> sourceTypes, Type targetType) Checks whether the provided sourceType and provided targetType match with the parameter respectively return type of the method.
void	mergeWithInverseMappings(SourceMethod inverseMethod) Merges in all the mappings configured via the given inverse mapping method, giving the locally defined mappings precedence.
boolean	overridesMethod() Whether an implementation of this method must be generated or not.
boolean	reverses(SourceMethod method)
void	setIterableMapping(IterableMapping iterableMapping)
void	setMapMapping(MapMapping mapMapping)
void	setMappings(Map<String,List<Mapping>> mappings)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

forMethodRequiringImplementation

public static SourceMethod forMethodRequiringImplementation(ExecutableElement executable,
                                                            List<Parameter> parameters,
                                                            Type returnType,
                                                            List<Type> exceptionTypes,
                                                            Map<String,List<Mapping>> mappings,
                                                            IterableMapping iterableMapping,
                                                            MapMapping mapMapping,
                                                            Types typeUtils,
                                                            Messager messager,
                                                            TypeFactory typeFactory)

forReferencedMethod

public static SourceMethod forReferencedMethod(Type declaringMapper,
                                               ExecutableElement executable,
                                               List<Parameter> parameters,
                                               Type returnType,
                                               List<Type> exceptionTypes,
                                               Types typeUtils)

forFactoryMethod

public static SourceMethod forFactoryMethod(Type declaringMapper,
                                            ExecutableElement executable,
                                            Type returnType,
                                            List<Type> exceptionTypes,
                                            Types typeUtils)

getDeclaringMapper

public Type getDeclaringMapper()

Returns the mapper type declaring this method if it is not declared by the mapper interface currently processed but by another mapper imported via Mapper#users(). Method

Specified by:

getDeclaringMapper in interface Method

Returns:

The declaring mapper type

getExecutable

public ExecutableElement getExecutable()

Specified by:

getExecutable in interface Method

getName

public String getName()

Returns then name of the method. Method

Specified by:

getName in interface Method

Returns:

method name

getParameters

public List<Parameter> getParameters()

In contrast to Method.getSourceParameters() this method returns all parameters Method

Specified by:

getParameters in interface Method

Returns:

all parameters

getSourceParameters

public List<Parameter> getSourceParameters()

returns the list of 'true' source parameters excluding the parameter(s) that is designated as target by means of the target annotation Method.getTargetParameter(). Method

Specified by:

getSourceParameters in interface Method

Returns:

list of 'true' source parameters

getParameterNames

public List<String> getParameterNames()

Specified by:

getParameterNames in interface Method

Returns:

the names of the parameters of this mapping method

getResultType

public Type getResultType()

Description copied from interface: Method

Returns the type of the result. The result is defined as the type of the parameter designated with MappingTarget, or in absence the return type.

Specified by:

getResultType in interface Method

Returns:

getReturnType

public Type getReturnType()

Returns the return type of the method Method

Specified by:

getReturnType in interface Method

Returns:

return type

getAccessibility

public Accessibility getAccessibility()

Description copied from interface: Method

Returns the Accessibility of this method.

Specified by:

getAccessibility in interface Method

Returns:

the Accessibility of this method

getMappings

public Map<String,List<Mapping>> getMappings()

Returns:

the Mappings configured for this method, keyed by target property name. Only for enum mapping methods a target will be mapped by several sources.

getSingleMappingByTargetPropertyName

public Mapping getSingleMappingByTargetPropertyName(String targetPropertyName)

setMappings

public void setMappings(Map<String,List<Mapping>> mappings)

getIterableMapping

public IterableMapping getIterableMapping()

setIterableMapping

public void setIterableMapping(IterableMapping iterableMapping)

getMapMapping

public MapMapping getMapMapping()

setMapMapping

public void setMapMapping(MapMapping mapMapping)

reverses

public boolean reverses(SourceMethod method)

getTargetParameter

public Parameter getTargetParameter()

Returns the parameter designated as target parameter (if present) Method.getSourceParameters() Method

Specified by:

getTargetParameter in interface Method

Returns:

target parameter (when present) null otherwise.

isIterableMapping

public boolean isIterableMapping()

isMapMapping

public boolean isMapMapping()

isEnumMapping

public boolean isEnumMapping()

toString

public String toString()

Overrides:

toString in class Object

getMappingBySourcePropertyName

public List<Mapping> getMappingBySourcePropertyName(String sourcePropertyName)

Returns the Mappings for the given source property.

Parameters:

sourcePropertyName - the source property name

Returns:

list of mappings

getSourceParameter

public Parameter getSourceParameter(String sourceParameterName)

overridesMethod

public boolean overridesMethod()

Whether an implementation of this method must be generated or not.

Specified by:

overridesMethod in interface Method

Returns:

true when an implementation is required

matches

public boolean matches(List<Type> sourceTypes,
                       Type targetType)

Checks whether the provided sourceType and provided targetType match with the parameter respectively return type of the method. The check also should incorporate wild card and generic type variables Method

Specified by:

matches in interface Method

Parameters:

sourceTypes - the sourceTypes to match to the parameter

targetType - the targetType to match to the returnType

Returns:

true when match

containsTargetTypeParameter

public static boolean containsTargetTypeParameter(List<Parameter> parameters)

Parameters:

parameters - the parameter list to check

Returns:

true if the parameter list contains a parameter annotated with @TargetType

getThrownTypes

public List<Type> getThrownTypes()

Description copied from interface: Method

Returns all exceptions thrown by this method

Specified by:

getThrownTypes in interface Method

Returns:

exceptions thrown

mergeWithInverseMappings

public void mergeWithInverseMappings(SourceMethod inverseMethod)

Merges in all the mappings configured via the given inverse mapping method, giving the locally defined mappings precedence.