Package org.mapstruct.ap.internal.model

Class SupportingField

java.lang.Object

org.mapstruct.ap.internal.writer.FreeMarkerWritable

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

org.mapstruct.ap.internal.model.Field

org.mapstruct.ap.internal.model.SupportingField

All Implemented Interfaces:

Writable

public class SupportingField
extends Field

supports the

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 SupportingMappingMethod	definingMethod
private java.lang.String	templateName
private java.util.Map<java.lang.String,java.lang.Object>	templateParameter

Constructor Summary

Constructors

Constructor	Description
SupportingField(SupportingMappingMethod definingMethod, FieldReference fieldReference, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
static void	addAllFieldsIn(java.util.Set<SupportingMappingMethod> supportingMappingMethods, java.util.Set<Field> targets)
SupportingMappingMethod	getDefiningMethod()
static Field	getSafeField(SupportingMappingMethod method, FieldReference ref, java.util.Set<Field> existingFields)
java.lang.String	getTemplateName()	Returns the name of the template to be used for a specific writable type.
java.util.Map<java.lang.String,java.lang.Object>	getTemplateParameter()

Methods inherited from class org.mapstruct.ap.internal.model.Field

equals, getFieldNames, getImportTypes, getType, getVariableName, hashCode, isTypeRequiresImport, isUsed, setTypeRequiresImport, setUsed

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

getTemplateNameForClass, write

Methods inherited from class java.lang.Object

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

Field Detail

templateName

private final java.lang.String templateName

templateParameter

private final java.util.Map<java.lang.String,java.lang.Object> templateParameter

definingMethod

private final SupportingMappingMethod definingMethod

Constructor Detail

SupportingField

public SupportingField(SupportingMappingMethod definingMethod,
                       FieldReference fieldReference,
                       java.lang.String name)

Method Detail

getTemplateName

public java.lang.String getTemplateName()

Description copied from class: FreeMarkerWritable

Returns the name of the template to be used for a specific writable type. By default, FreeMarkerWritable.getTemplateNameForClass(Class) is called with getClass(), but this can be customized by overriding this method if required.

Overrides:

getTemplateName in class FreeMarkerWritable

Returns:

the name of the template. Must not be null.

getTemplateParameter

public java.util.Map<java.lang.String,java.lang.Object> getTemplateParameter()

getDefiningMethod

public SupportingMappingMethod getDefiningMethod()

addAllFieldsIn

public static void addAllFieldsIn(java.util.Set<SupportingMappingMethod> supportingMappingMethods,
                                  java.util.Set<Field> targets)

getSafeField

public static Field getSafeField(SupportingMappingMethod method,
                                 FieldReference ref,
                                 java.util.Set<Field> existingFields)