Package org.mapstruct.ap.internal.model

Class MappingMethod

java.lang.Object

org.mapstruct.ap.internal.writer.FreeMarkerWritable

org.mapstruct.ap.internal.model.common.ModelElement

org.mapstruct.ap.internal.model.MappingMethod

All Implemented Interfaces:

Writable

Direct Known Subclasses:

DelegatingMethod, NestedPropertyMappingMethod, NormalTypeMappingMethod, SupportingMappingMethod, ValueMappingMethod

public abstract class MappingMethod
extends ModelElement

A method implemented or referenced by a Mapper class.

Nested Class Summary

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

Writable.Context

Field Summary

Fields

Modifier and Type	Field	Description
private Accessibility	accessibility
private java.util.List<LifecycleCallbackMethodReference>	afterMappingReferences
private java.util.List<LifecycleCallbackMethodReference>	beforeMappingReferencesWithMappingTarget
private java.util.List<LifecycleCallbackMethodReference>	beforeMappingReferencesWithoutMappingTarget
private boolean	isStatic
private java.lang.String	name
private java.util.List<Parameter>	parameters
private java.lang.String	resultName
private Type	returnType
private java.util.List<Parameter>	sourceParameters
private Parameter	targetParameter
private java.util.List<Type>	thrownTypes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MappingMethod(Method method)
protected	MappingMethod(Method method, java.util.Collection<java.lang.String> existingVariableNames, java.util.List<LifecycleCallbackMethodReference> beforeMappingReferences, java.util.List<LifecycleCallbackMethodReference> afterMappingReferences)	constructor to be overloaded when local variable names are required prior to calling this constructor.
protected	MappingMethod(Method method, java.util.List<Parameter> parameters)
protected	MappingMethod(Method method, java.util.List<Parameter> parameters, java.util.Collection<java.lang.String> existingVariableNames, java.util.List<LifecycleCallbackMethodReference> beforeMappingReferences, java.util.List<LifecycleCallbackMethodReference> afterMappingReferences)
protected	MappingMethod(Method method, java.util.List<LifecycleCallbackMethodReference> beforeMappingReferences, java.util.List<LifecycleCallbackMethodReference> afterMappingReferences)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
private java.util.List<LifecycleCallbackMethodReference>	filterMappingTarget(java.util.List<LifecycleCallbackMethodReference> methods, boolean mustHaveMappingTargetParameter)
Accessibility	getAccessibility()
java.util.List<LifecycleCallbackMethodReference>	getAfterMappingReferences()
java.util.List<LifecycleCallbackMethodReference>	getBeforeMappingReferencesWithMappingTarget()
java.util.List<LifecycleCallbackMethodReference>	getBeforeMappingReferencesWithoutMappingTarget()
java.util.Set<Type>	getImportTypes()	Returns a set containing those Types referenced by this model element for which an import statement needs to be declared.
java.lang.String	getName()
protected java.util.List<java.lang.String>	getParameterNames()
java.util.List<Parameter>	getParameters()
java.lang.String	getResultName()
Type	getResultType()
Type	getReturnType()
java.util.List<Parameter>	getSourceParameters()
java.util.List<Type>	getThrownTypes()
int	hashCode()
private java.lang.String	initResultName(java.util.Collection<java.lang.String> existingVarNames)
boolean	isExistingInstanceMapping()
boolean	isStatic()
java.lang.String	toString()

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

getTemplateName, getTemplateNameForClass, write

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

parameters

private final java.util.List<Parameter> parameters

sourceParameters

private final java.util.List<Parameter> sourceParameters

returnType

private final Type returnType

targetParameter

private final Parameter targetParameter

accessibility

private final Accessibility accessibility

thrownTypes

private final java.util.List<Type> thrownTypes

isStatic

private final boolean isStatic

resultName

private final java.lang.String resultName

beforeMappingReferencesWithMappingTarget

private final java.util.List<LifecycleCallbackMethodReference> beforeMappingReferencesWithMappingTarget

beforeMappingReferencesWithoutMappingTarget

private final java.util.List<LifecycleCallbackMethodReference> beforeMappingReferencesWithoutMappingTarget

afterMappingReferences

private final java.util.List<LifecycleCallbackMethodReference> afterMappingReferences

Constructor Detail

MappingMethod

protected MappingMethod(Method method,
                        java.util.Collection<java.lang.String> existingVariableNames,
                        java.util.List<LifecycleCallbackMethodReference> beforeMappingReferences,
                        java.util.List<LifecycleCallbackMethodReference> afterMappingReferences)

constructor to be overloaded when local variable names are required prior to calling this constructor. (e.g. for property mappings). It is supposed to be initialized with at least the parameter names.

Parameters:

method - the method for which this mapping is applicable

existingVariableNames - set of already assigned variable names

beforeMappingReferences - all life cycle methods to be called prior to carrying out mapping

afterMappingReferences - all life cycle methods to be called after carrying out mapping

MappingMethod

protected MappingMethod(Method method,
                        java.util.List<Parameter> parameters,
                        java.util.Collection<java.lang.String> existingVariableNames,
                        java.util.List<LifecycleCallbackMethodReference> beforeMappingReferences,
                        java.util.List<LifecycleCallbackMethodReference> afterMappingReferences)

MappingMethod

protected MappingMethod(Method method,
                        java.util.List<Parameter> parameters)

MappingMethod

protected MappingMethod(Method method)

MappingMethod

protected MappingMethod(Method method,
                        java.util.List<LifecycleCallbackMethodReference> beforeMappingReferences,
                        java.util.List<LifecycleCallbackMethodReference> afterMappingReferences)

Method Detail

initResultName

private java.lang.String initResultName(java.util.Collection<java.lang.String> existingVarNames)

getName

public java.lang.String getName()

getParameters

public java.util.List<Parameter> getParameters()

getSourceParameters

public java.util.List<Parameter> getSourceParameters()

getResultType

public Type getResultType()

getResultName

public java.lang.String getResultName()

getReturnType

public Type getReturnType()

getAccessibility

public Accessibility getAccessibility()

isExistingInstanceMapping

public boolean isExistingInstanceMapping()

isStatic

public boolean isStatic()

getImportTypes

public java.util.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.

Specified by:

getImportTypes in class ModelElement

Returns:

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

getParameterNames

protected java.util.List<java.lang.String> getParameterNames()

getThrownTypes

public java.util.List<Type> getThrownTypes()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

filterMappingTarget

private java.util.List<LifecycleCallbackMethodReference> filterMappingTarget(java.util.List<LifecycleCallbackMethodReference> methods,
                                                                             boolean mustHaveMappingTargetParameter)

getAfterMappingReferences

public java.util.List<LifecycleCallbackMethodReference> getAfterMappingReferences()

getBeforeMappingReferencesWithMappingTarget

public java.util.List<LifecycleCallbackMethodReference> getBeforeMappingReferencesWithMappingTarget()

getBeforeMappingReferencesWithoutMappingTarget

public java.util.List<LifecycleCallbackMethodReference> getBeforeMappingReferencesWithoutMappingTarget()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object