org.mapstruct.ap.model.source.builtin

Class BuiltInMethod

java.lang.Object

org.mapstruct.ap.model.source.builtin.BuiltInMethod

All Implemented Interfaces:

Method

Direct Known Subclasses:

CalendarToXmlGregorianCalendar, CalendarToZonedDateTime, DateToXmlGregorianCalendar, JaxbElemToValue, StringToXmlGregorianCalendar, XmlGregorianCalendarToCalendar, XmlGregorianCalendarToDate, XmlGregorianCalendarToString, ZonedDateTimeToCalendar

public abstract class BuiltInMethod
extends Object
implements Method

Represents a "built-in" mapping method which will be added as private method to the generated mapper. Built-in methods are used in cases where a SimpleConversion doesn't suffice, e.g. as several lines of source code or a try/catch block are required.

Author:

Sjaak Derksen

Constructor Summary

Constructors

Constructor and Description
BuiltInMethod()

Method Summary

Modifier and Type	Method and Description
boolean	doTypeVarsMatch(Type parameter, Type returnType) Analyzes the Java Generic type variables in the parameter do match the type variables in the build in method same goes for the returnType.
boolean	equals(Object obj) equals based on class
Accessibility	getAccessibility() Returns the Accessibility of this method.
String	getContextParameter(ConversionContext conversionContext) the conversion context is used to format an auxiliary parameter in the method call with context specific information such as a date format.
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()
Set<Type>	getImportTypes() Returns the types used by this method for which import statements need to be generated.
MapperConfiguration	getMapperConfiguration()
Parameter	getMappingTargetParameter() mapping target parameter mechanism not supported for built-in methods
String	getName() Returns then name of the method.
abstract Parameter	getParameter() There's currently only one parameter foreseen instead of a list of parameter
List<String>	getParameterNames()
List<Parameter>	getParameters() In contrast to Method.getSourceParameters() this method returns all parameters
Type	getResultType() Returns the type of the result.
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() target type parameter mechanism not supported for built-in methods
List<Type>	getThrownTypes() Returns all exceptions thrown by this method
int	hashCode() hashCode based on class
boolean	isStatic() Whether this method is static or an instance method
boolean	matches(Type sourceType, 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mapstruct.ap.model.source.Method

getReturnType

Constructor Detail

BuiltInMethod

public BuiltInMethod()

Method Detail

getName

public String getName()

Returns then name of the method.

Specified by:

getName in interface Method

Returns:

default method name is equal to class name of build in method name

getImportTypes

public Set<Type> getImportTypes()

Returns the types used by this method for which import statements need to be generated. Defaults to the empty set. To be overridden by implementations in case they make use of additional types (note that the parameter and return type don't need to be added).

Returns:

the types used by this method for which import statements need to be generated

matches

public boolean matches(Type sourceType,
                       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

Default the targetType should be assignable to the returnType and the sourceType to the parameter, excluding generic type variables. When the implementor sees a need for this, this method can be overridden.

Specified by:

matches in interface Method

Parameters:

sourceType - the sourceType to match to the parameter

targetType - the targetType to match to the returnType

Returns:

true when match

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

getDeclaringMapper

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

For built-in methods, the declaring mapper is always null as they will be added as private methods to the generated mapper.

Specified by:

getDeclaringMapper in interface Method

Returns:

null

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

getMappingTargetParameter

public Parameter getMappingTargetParameter()

mapping target parameter mechanism not supported for built-in methods

Specified by:

getMappingTargetParameter in interface Method

Returns:

null

getTargetTypeParameter

public Parameter getTargetTypeParameter()

target type parameter mechanism not supported for built-in methods

Specified by:

getTargetTypeParameter in interface Method

Returns:

null

getContextParameter

public String getContextParameter(ConversionContext conversionContext)

the conversion context is used to format an auxiliary parameter in the method call with context specific information such as a date format.

Parameters:

conversionContext -

Returns:

null if no context parameter should be included "null" if there should be an explicit null call "'dateFormat'" for instance, to indicate how the build-in method should format the date

hashCode

public int hashCode()

hashCode based on class

Overrides:

hashCode in class Object

Returns:

hashCode

equals

public boolean equals(Object obj)

equals based on class

Overrides:

equals in class Object

Parameters:

obj - other class

Returns:

true when classes are the same

doTypeVarsMatch

public boolean doTypeVarsMatch(Type parameter,
                               Type returnType)

Analyzes the Java Generic type variables in the parameter do match the type variables in the build in method same goes for the returnType.

Parameters:

parameter - source

returnType - target

Returns:

getParameter

public abstract Parameter getParameter()

There's currently only one parameter foreseen instead of a list of parameter

Returns:

the parameter

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

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

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