org.mapstruct.ap.model.source

Class SourceMethod

java.lang.Object

org.mapstruct.ap.model.source.SourceMethod

All Implemented Interfaces:

Method

public class SourceMethod
extends java.lang.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(java.util.List<Parameter> parameters)
static SourceMethod	forFactoryMethod(Type declaringMapper, javax.lang.model.element.ExecutableElement executable, Type returnType, java.util.List<Type> exceptionTypes, javax.lang.model.util.Types typeUtils)
static SourceMethod	forMethodRequiringImplementation(javax.lang.model.element.ExecutableElement executable, java.util.List<Parameter> parameters, Type returnType, java.util.List<Type> exceptionTypes, java.util.Map<java.lang.String,java.util.List<Mapping>> mappings, IterableMapping iterableMapping, MapMapping mapMapping, javax.lang.model.util.Types typeUtils)
static SourceMethod	forReferencedMethod(Type declaringMapper, javax.lang.model.element.ExecutableElement executable, java.util.List<Parameter> parameters, Type returnType, java.util.List<Type> exceptionTypes, javax.lang.model.util.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().
javax.lang.model.element.ExecutableElement	getExecutable()
IterableMapping	getIterableMapping()
MapMapping	getMapMapping()
Mapping	getMappingByTargetPropertyName(java.lang.String targetPropertyName) Returns the Mapping for the given target property.
java.util.Map<java.lang.String,java.util.List<Mapping>>	getMappings() Returns the Mappings configured for this method, keyed by source property name.
java.lang.String	getName() Returns then name of the method.
java.util.List<java.lang.String>	getParameterNames()
java.util.List<Parameter>	getParameters() In contrast to Method.getSourceParameters() this method returns all parameters
Type	getResultType()
Type	getReturnType() Returns the return type of the method
Parameter	getSourceParameter(java.lang.String sourceParameterName)
java.util.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()
java.util.List<Type>	getThrownTypes() Returns all exceptions thrown by this method
boolean	isConfiguredByReverseMappingMethod() Whether this method is configured by itself or by the corresponding reverse mapping method.
boolean	isEnumMapping()
boolean	isIterableMapping()
boolean	isMapMapping()
boolean	matches(java.util.List<Type> sourceTypes, Type targetType) Checks whether the provided sourceType and provided targetType match with the parameter respectively return type of the method.
boolean	requiresImplementation() 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(java.util.Map<java.lang.String,java.util.List<Mapping>> mappings)
java.lang.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(javax.lang.model.element.ExecutableElement executable,
                                                            java.util.List<Parameter> parameters,
                                                            Type returnType,
                                                            java.util.List<Type> exceptionTypes,
                                                            java.util.Map<java.lang.String,java.util.List<Mapping>> mappings,
                                                            IterableMapping iterableMapping,
                                                            MapMapping mapMapping,
                                                            javax.lang.model.util.Types typeUtils)

forReferencedMethod

public static SourceMethod forReferencedMethod(Type declaringMapper,
                                               javax.lang.model.element.ExecutableElement executable,
                                               java.util.List<Parameter> parameters,
                                               Type returnType,
                                               java.util.List<Type> exceptionTypes,
                                               javax.lang.model.util.Types typeUtils)

forFactoryMethod

public static SourceMethod forFactoryMethod(Type declaringMapper,
                                            javax.lang.model.element.ExecutableElement executable,
                                            Type returnType,
                                            java.util.List<Type> exceptionTypes,
                                            javax.lang.model.util.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 javax.lang.model.element.ExecutableElement getExecutable()

getName

public java.lang.String getName()

Returns then name of the method. Method

Specified by:

getName in interface Method

Returns:

method name

getParameters

public java.util.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 java.util.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 java.util.List<java.lang.String> getParameterNames()

getResultType

public Type getResultType()

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 java.util.Map<java.lang.String,java.util.List<Mapping>> getMappings()

Returns the Mappings configured for this method, keyed by source property name.

setMappings

public void setMappings(java.util.Map<java.lang.String,java.util.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()

isConfiguredByReverseMappingMethod

public boolean isConfiguredByReverseMappingMethod()

Whether this method is configured by itself or by the corresponding reverse mapping method.

Returns:

true if this method is configured by itself, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMappingByTargetPropertyName

public Mapping getMappingByTargetPropertyName(java.lang.String targetPropertyName)

Returns the Mapping for the given target property. May return null.

getSourceParameter

public Parameter getSourceParameter(java.lang.String sourceParameterName)

requiresImplementation

public boolean requiresImplementation()

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

Returns:

true when an implementation is required

matches

public boolean matches(java.util.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(java.util.List<Parameter> parameters)

Parameters:

parameters - the parameter list to check

Returns:

true, iff the parameter list contains a parameter annotated with @TargetType

getThrownTypes

public java.util.List<Type> getThrownTypes()

Description copied from interface: Method

Returns all exceptions thrown by this method

Specified by:

getThrownTypes in interface Method

Returns:

exceptions thrown