Method (MapStruct 1.0.0.Final)

All Known Implementing Classes:

BuiltInMethod, CalendarToXmlGregorianCalendar, CalendarToZonedDateTime, DateToXmlGregorianCalendar, ForgedMethod, JaxbElemToValue, SourceMethod, StringToXmlGregorianCalendar, XmlGregorianCalendarToCalendar, XmlGregorianCalendarToDate, XmlGregorianCalendarToString, ZonedDateTimeToCalendar
```
public interface Method
```
This interface makes available common method properties and a matching method There are 2 known implementors: BuiltInMethod and SourceMethod

Author:

Sjaak Derksen

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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()`.
`Type`	`getDefiningType()`
`ExecutableElement`	`getExecutable()`
`MapperConfiguration`	`getMapperConfiguration()`
`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 `getSourceParameters()` this method returns all parameters
`Type`	`getResultType()` Returns the type of the result.
`Type`	`getReturnType()` Returns the return type of the method
`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 `getMappingTargetParameter()`.
`Parameter`	`getTargetTypeParameter()` Returns the parameter designated as target type (if present) `TargetType`
`List<Type>`	`getThrownTypes()` Returns all exceptions thrown by this method
`boolean`	`isDefault()` Whether this method is Java 8 default method
`boolean`	`isLifecycleCallbackMethod()`
`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 this method overrides an abstract method.

- Method Detail
  - matches
```
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
    
    Parameters:
    
    sourceTypes - the sourceTypes to match to the parameter
    
    targetType - the targetType to match to the returnType
    
    Returns:
    
    true when match
  - getDeclaringMapper
```
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
  - getName
```
String getName()
```
    Returns then name of the method.
    
    Returns:
    
    method name
  - getParameters
```
List<Parameter> getParameters()
```
    In contrast to getSourceParameters() this method returns all parameters
    
    Returns:
    
    all parameters
  - getSourceParameters
```
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 getMappingTargetParameter().
    
    Returns:
    
    list of 'true' source parameters
  - getMappingTargetParameter
```
Parameter getMappingTargetParameter()
```
    Returns the parameter designated as mapping target (if present) MappingTarget
    
    Returns:
    
    mapping target parameter (when present) null otherwise.
  - getTargetTypeParameter
```
Parameter getTargetTypeParameter()
```
    Returns the parameter designated as target type (if present) TargetType
    
    Returns:
    
    target type parameter (when present) null otherwise.
  - getAccessibility
```
Accessibility getAccessibility()
```
    Returns the Accessibility of this method.
    
    Returns:
    
    the Accessibility of this method
  - getReturnType
```
Type getReturnType()
```
    Returns the return type of the method
    
    Returns:
    
    return type
  - getThrownTypes
```
List<Type> getThrownTypes()
```
    Returns all exceptions thrown by this method
    
    Returns:
    
    exceptions thrown
  - getResultType
```
Type getResultType()
```
    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.
    
    Returns:
    
    result type
  - getParameterNames
```
List<String> getParameterNames()
```
    Returns:
    
    the names of the parameters of this mapping method
  - overridesMethod
```
boolean overridesMethod()
```
    Whether this method overrides an abstract method.
    
    Returns:
    
    true when an abstract method is overridden.
  - getExecutable
```
ExecutableElement getExecutable()
```
  - isStatic
```
boolean isStatic()
```
    Whether this method is static or an instance method
    
    Returns:
    
    true when static.
  - isDefault
```
boolean isDefault()
```
    Whether this method is Java 8 default method
    
    Returns:
    
    true when Java 8 default method
  - getDefiningType
```
Type getDefiningType()
```
    Returns:
    
    the Type (class or interface) that defines this method.
  - getMapperConfiguration
```
MapperConfiguration getMapperConfiguration()
```
    Returns:
    
    the mapper config when this method needs to be implemented
  - isLifecycleCallbackMethod
```
boolean isLifecycleCallbackMethod()
```
    Returns:
    
    true, if the method represents a mapping lifecycle callback (Before/After mapping method)
  - isUpdateMethod
```
boolean isUpdateMethod()
```
    Returns:
    
    true, if the method is an update method, i.e. it has a parameter annotated with @MappingTarget.

Interface Method

Method Summary

Method Detail

matches

getDeclaringMapper

getName

getParameters

getSourceParameters

getMappingTargetParameter

getTargetTypeParameter

getAccessibility

getReturnType

getThrownTypes

getResultType

getParameterNames

overridesMethod

getExecutable

isStatic

isDefault

getDefiningType

getMapperConfiguration

isLifecycleCallbackMethod

isUpdateMethod