org.mapstruct.ap.model.source

Interface Method

All Known Implementing Classes:

BuiltInMethod, CalendarToXmlGregorianCalendar, DateToXmlGregorianCalendar, JaxbElemToValue, ListOfJaxbElemToListOfValue, SourceMethod, StringToXmlGregorianCalendar, XmlGregorianCalendarToCalendar, XmlGregorianCalendarToDate, XmlGregorianCalendarToString

public interface Method

This interface makes available common method properties and a matching method There are 2 known implementors: BuiltInMethod and Method

Author:

Sjaak Derksen

Method Summary

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().
java.lang.String	getName() Returns then name of the method.
java.util.List<Parameter>	getParameters() In contrast to getSourceParameters() this method returns all parameters
Type	getReturnType() Returns the return type of the method
java.util.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 getTargetParameter().
Parameter	getTargetParameter() Returns the parameter designated as target parameter (if present) getSourceParameters()
java.util.List<Type>	getThrownTypes() Returns all exceptions thrown by this method
boolean	matches(java.util.List<Type> sourceTypes, Type targetType) Checks whether the provided sourceType and provided targetType match with the parameter respectively return type of the method.

Method Detail

matches

boolean matches(java.util.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

java.lang.String getName()

Returns then name of the method.

Returns:

method name

getParameters

java.util.List<Parameter> getParameters()

In contrast to getSourceParameters() this method returns all parameters

Returns:

all parameters

getSourceParameters

java.util.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 getTargetParameter().

Returns:

list of 'true' source parameters

getTargetParameter

Parameter getTargetParameter()

Returns the parameter designated as target parameter (if present) getSourceParameters()

Returns:

target 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

java.util.List<Type> getThrownTypes()

Returns all exceptions thrown by this method

Returns:

exceptions thrown