SourceMethod (MapStruct 1.0.0.Final)

java.lang.Object
- org.mapstruct.ap.internal.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 (the appropriate setter on MappingOptions will be called in this case).

Author:

Gunnar Morling

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SourceMethod.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SourceMethod.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canInheritFrom(SourceMethod method)`
`static boolean`	`containsTargetTypeParameter(List<Parameter> parameters)`
`Accessibility`	`getAccessibility()` Returns the `Accessibility` of this method.
`List<SourceMethod>`	`getApplicablePrototypeMethods()`
`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()`.
`Type`	`getDefiningType()`
`ExecutableElement`	`getExecutable()`
`MapperConfiguration`	`getMapperConfiguration()`
`List<Mapping>`	`getMappingBySourcePropertyName(String sourcePropertyName)` Returns the `Mapping`s for the given source property.
`MappingOptions`	`getMappingOptions()`
`Parameter`	`getMappingTargetParameter()` Returns the parameter designated as mapping target (if present) `MappingTarget`
`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.getMappingTargetParameter()`.
`Parameter`	`getTargetTypeParameter()` Returns the parameter designated as target type (if present) `TargetType`
`List<Type>`	`getThrownTypes()` Returns all exceptions thrown by this method
`boolean`	`isAfterMappingMethod()`
`boolean`	`isBeforeMappingMethod()`
`boolean`	`isDefault()` Whether this method is Java 8 default method
`boolean`	`isEnumMapping()`
`boolean`	`isIterableMapping()`
`boolean`	`isLifecycleCallbackMethod()`
`boolean`	`isMapMapping()`
`boolean`	`isSame(SourceMethod method)`
`boolean`	`isStatic()` Whether this method is static or an instance method
`boolean`	`isUpdateMethod()`
`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.
`boolean`	`overridesMethod()` Whether an implementation of this method must be generated or not.
`boolean`	`reverses(SourceMethod method)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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.getMappingTargetParameter(). 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:
    
    result type
  - 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
  - getSingleMappingByTargetPropertyName
```
public Mapping getSingleMappingByTargetPropertyName(String targetPropertyName)
```
  - reverses
```
public boolean reverses(SourceMethod method)
```
  - isSame
```
public boolean isSame(SourceMethod method)
```
  - canInheritFrom
```
public boolean canInheritFrom(SourceMethod method)
```
  - getMappingTargetParameter
```
public Parameter getMappingTargetParameter()
```
    Description copied from interface: Method
    
    Returns the parameter designated as mapping target (if present) MappingTarget
    
    Specified by:
    
    getMappingTargetParameter in interface Method
    
    Returns:
    
    mapping target parameter (when present) null otherwise.
  - getTargetTypeParameter
```
public Parameter getTargetTypeParameter()
```
    Description copied from interface: Method
    
    Returns the parameter designated as target type (if present) TargetType
    
    Specified by:
    
    getTargetTypeParameter in interface Method
    
    Returns:
    
    target type 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)
```
  - getApplicablePrototypeMethods
```
public List<SourceMethod> getApplicablePrototypeMethods()
```
  - 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
  - getMappingOptions
```
public MappingOptions getMappingOptions()
```
  - isStatic
```
public boolean isStatic()
```
    Description copied from interface: Method
    
    Whether this method is static or an instance method
    
    Specified by:
    
    isStatic in interface Method
    
    Returns:
    
    true when static.
  - isDefault
```
public boolean isDefault()
```
    Description copied from interface: Method
    
    Whether this method is Java 8 default method
    
    Specified by:
    
    isDefault in interface Method
    
    Returns:
    
    true when Java 8 default method
  - getDefiningType
```
public Type getDefiningType()
```
    Specified by:
    
    getDefiningType in interface Method
    
    Returns:
    
    the Type (class or interface) that defines this method.
  - getMapperConfiguration
```
public MapperConfiguration getMapperConfiguration()
```
    Specified by:
    
    getMapperConfiguration in interface Method
    
    Returns:
    
    the mapper config when this method needs to be implemented
  - isLifecycleCallbackMethod
```
public boolean isLifecycleCallbackMethod()
```
    Specified by:
    
    isLifecycleCallbackMethod in interface Method
    
    Returns:
    
    true, if the method represents a mapping lifecycle callback (Before/After mapping method)
  - isAfterMappingMethod
```
public boolean isAfterMappingMethod()
```
  - isBeforeMappingMethod
```
public boolean isBeforeMappingMethod()
```
  - isUpdateMethod
```
public boolean isUpdateMethod()
```
    Specified by:
    
    isUpdateMethod in interface Method
    
    Returns:
    
    true, if the method is an update method, i.e. it has a parameter annotated with @MappingTarget.

Class SourceMethod

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDeclaringMapper

getExecutable

getName

getParameters

getSourceParameters

getParameterNames

getResultType

getReturnType

getAccessibility

getSingleMappingByTargetPropertyName

reverses

isSame

canInheritFrom

getMappingTargetParameter

getTargetTypeParameter

isIterableMapping

isMapMapping

isEnumMapping

toString

getMappingBySourcePropertyName

getSourceParameter

getApplicablePrototypeMethods

overridesMethod

matches

containsTargetTypeParameter

getThrownTypes

getMappingOptions

isStatic

isDefault

getDefiningType

getMapperConfiguration

isLifecycleCallbackMethod

isAfterMappingMethod

isBeforeMappingMethod

isUpdateMethod