ForgedMethod (MapStruct Processor 1.0.0.Beta4 API)

java.lang.Object
- org.mapstruct.ap.model.source.ForgedMethod

All Implemented Interfaces:

Method
```
public class ForgedMethod
extends Object
implements Method
```
This method will be generated in absence of a suitable abstract method to implement.

Author:

Sjaak Derksen

Constructor Summary

Constructors
Constructor and Description
`ForgedMethod(String name, ForgedMethod forgedMethod)` creates a new ForgedMethod with the same arguments but with a new name
`ForgedMethod(String name, Type sourceType, Type targetType, ExecutableElement positionHintElement)` Creates a new forged method with the given name.

Method Summary

All Methods Instance Methods Concrete 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()`.
`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 `Method.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 `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`	`isStatic()` Whether this method is static or an instance method
`boolean`	`matches(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.
`String`	`toString()`

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

- Constructor Detail
  - ForgedMethod
```
public ForgedMethod(String name,
                    Type sourceType,
                    Type targetType,
                    ExecutableElement positionHintElement)
```
    Creates a new forged method with the given name.
    
    Parameters:
    
    name - the (unique name) for this method
    
    sourceType - the source type
    
    targetType - the target type.
    
    positionHintElement - element used to for reference to the position in the source file.
  - ForgedMethod
```
public ForgedMethod(String name,
                    ForgedMethod forgedMethod)
```
    creates a new ForgedMethod with the same arguments but with a new name
    
    Parameters:
    
    name - the new name
    
    forgedMethod - existing forge method
- Method Detail
  - matches
```
public boolean matches(Type sourceTypes,
                       Type targetType)
```
    Description copied from interface: Method
    
    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
    
    Specified by:
    
    matches in interface Method
    
    Parameters:
    
    sourceTypes - the sourceType to match to the parameter
    
    targetType - the targetType to match to the returnType
    
    Returns:
    
    true when match
  - getDeclaringMapper
```
public Type getDeclaringMapper()
```
    Description copied from interface: Method
    
    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().
    
    Specified by:
    
    getDeclaringMapper in interface Method
    
    Returns:
    
    The declaring mapper type
  - getName
```
public String getName()
```
    Description copied from interface: Method
    
    Returns then name of the method.
    
    Specified by:
    
    getName in interface Method
    
    Returns:
    
    method name
  - getParameters
```
public List<Parameter> getParameters()
```
    Description copied from interface: Method
    
    In contrast to Method.getSourceParameters() this method returns all parameters
    
    Specified by:
    
    getParameters in interface Method
    
    Returns:
    
    all parameters
  - getSourceParameters
```
public List<Parameter> getSourceParameters()
```
    Description copied from interface: Method
    
    returns the list of 'true' source parameters excluding the parameter(s) that is designated as target by means of the target annotation Method.getMappingTargetParameter().
    
    Specified by:
    
    getSourceParameters in interface Method
    
    Returns:
    
    list of 'true' source parameters
  - 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.
  - 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
  - getReturnType
```
public Type getReturnType()
```
    Description copied from interface: Method
    
    Returns the return type of the method
    
    Specified by:
    
    getReturnType in interface Method
    
    Returns:
    
    return type
  - 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
  - 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:
  - getParameterNames
```
public List<String> getParameterNames()
```
    Specified by:
    
    getParameterNames in interface Method
    
    Returns:
    
    the names of the parameters of this mapping method
  - overridesMethod
```
public boolean overridesMethod()
```
    Description copied from interface: Method
    
    Whether this method overrides an abstract method.
    
    Specified by:
    
    overridesMethod in interface Method
    
    Returns:
    
    true when an abstract method is overridden.
  - getExecutable
```
public ExecutableElement getExecutable()
```
    Specified by:
    
    getExecutable in interface Method
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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.
  - getMapperConfiguration
```
public MapperConfiguration getMapperConfiguration()
```
    Specified by:
    
    getMapperConfiguration in interface Method
    
    Returns:
    
    the mapper config when this method needs to be implemented

Class ForgedMethod

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ForgedMethod

ForgedMethod

Method Detail

matches

getDeclaringMapper

getName

getParameters

getSourceParameters

getMappingTargetParameter

getTargetTypeParameter

getAccessibility

getReturnType

getThrownTypes

getResultType

getParameterNames

overridesMethod

getExecutable

toString

isStatic

getMapperConfiguration