org.mapstruct.ap.model.source

Class Method

java.lang.Object

org.mapstruct.ap.model.source.Method

public class Method
extends Object

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

Author:

Gunnar Morling

Method Summary

Methods

Modifier and Type	Method and Description
static Method	forMethodRequiringImplementation(ExecutableElement executable, List<Parameter> parameters, Type returnType, Map<String,Mapping> mappings, IterableMapping iterableMapping, MapMapping mapMapping)
static Method	forReferencedMethod(Type declaringMapper, ExecutableElement executable, List<Parameter> parameters, Type returnType)
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()
Mapping	getMapping(String targetPropertyName)
Map<String,Mapping>	getMappings()
String	getName()
List<String>	getParameterNames()
List<Parameter>	getParameters()
Type	getResultType()
Type	getReturnType()
Parameter	getSourceParameter(String sourceParameterName)
List<Parameter>	getSourceParameters()
Parameter	getTargetParameter()
boolean	isIterableMapping()
boolean	isMapMapping()
boolean	reverses(Method method)
void	setIterableMapping(IterableMapping iterableMapping)
void	setMapMapping(MapMapping mapMapping)
void	setMappings(Map<String,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 Method forMethodRequiringImplementation(ExecutableElement executable,
                                      List<Parameter> parameters,
                                      Type returnType,
                                      Map<String,Mapping> mappings,
                                      IterableMapping iterableMapping,
                                      MapMapping mapMapping)

forReferencedMethod

public static Method forReferencedMethod(Type declaringMapper,
                         ExecutableElement executable,
                         List<Parameter> parameters,
                         Type returnType)

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().

Returns:

The declaring mapper type

getExecutable

public ExecutableElement getExecutable()

getName

public String getName()

getParameters

public List<Parameter> getParameters()

getSourceParameters

public List<Parameter> getSourceParameters()

getParameterNames

public List<String> getParameterNames()

getResultType

public Type getResultType()

getReturnType

public Type getReturnType()

getMappings

public Map<String,Mapping> getMappings()

setMappings

public void setMappings(Map<String,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(Method method)

getTargetParameter

public Parameter getTargetParameter()

isIterableMapping

public boolean isIterableMapping()

isMapMapping

public boolean isMapMapping()

toString

public String toString()

Overrides:

toString in class Object

getMapping

public Mapping getMapping(String targetPropertyName)

getSourceParameter

public Parameter getSourceParameter(String sourceParameterName)