org.mapstruct.ap.model

Class MethodReference

java.lang.Object

org.mapstruct.ap.writer.FreeMarkerWritable

org.mapstruct.ap.model.common.ModelElement

org.mapstruct.ap.model.MappingMethod

org.mapstruct.ap.model.MethodReference

All Implemented Interfaces:

Writable

public class MethodReference
extends MappingMethod

Represents a reference to MappingMethod.

Author:

Gunnar Morling

Nested Class Summary

Nested classes/interfaces inherited from interface org.mapstruct.ap.writer.Writable

Writable.Context

Constructor Summary

Constructors

Constructor and Description
MethodReference(BuiltInMethod method, ConversionContext contextParam)
MethodReference(SourceMethod method, MapperReference declaringMapper, Type targetType) Creates a new reference to the given method.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContextParam()
MapperReference	getDeclaringMapper()
Set<Type>	getImportTypes() Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
String	getMapperVariableName()
MethodReference	getMethodRefChild()
Type	getSingleSourceParameterType()
void	setMethodRefChild(MethodReference methodRefChild)

Methods inherited from class org.mapstruct.ap.model.MappingMethod

getAccessibility, getName, getParameterNames, getParameters, getResultName, getResultType, getReturnType, getSourceParameters, isExistingInstanceMapping, toString

Methods inherited from class org.mapstruct.ap.model.common.ModelElement

write

Methods inherited from class org.mapstruct.ap.writer.FreeMarkerWritable

getTemplateName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MethodReference

public MethodReference(SourceMethod method,
               MapperReference declaringMapper,
               Type targetType)

Creates a new reference to the given method.

Parameters:

method - the target method of the reference

declaringMapper - the method declaring the mapper; null if the current mapper itself

targetType - in case the referenced method has a parameter for passing the target type, the given target type, otherwise null

MethodReference

public MethodReference(BuiltInMethod method,
               ConversionContext contextParam)

Method Detail

getDeclaringMapper

public MapperReference getDeclaringMapper()

getMapperVariableName

public String getMapperVariableName()

getContextParam

public String getContextParam()

getSingleSourceParameterType

public Type getSingleSourceParameterType()

Returns:

the type of the single source parameter that is not the @TargetType parameter

setMethodRefChild

public void setMethodRefChild(MethodReference methodRefChild)

getMethodRefChild

public MethodReference getMethodRefChild()

getImportTypes

public Set<Type> getImportTypes()

Description copied from class: ModelElement

Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.

Overrides:

getImportTypes in class MappingMethod

Returns:

A set with type referenced by this model element. Must not be null.