org.mapstruct.ap.internal.model.source

Class MappingOptions

java.lang.Object

org.mapstruct.ap.internal.model.source.MappingOptions

public class MappingOptions
extends Object

Encapsulates all options specifiable on a mapping method

Author:

Andreas Gudian

Constructor Summary

Constructors

Constructor and Description
MappingOptions(Map<String,List<Mapping>> mappings, IterableMapping iterableMapping, MapMapping mapMapping, BeanMapping beanMapping, List<ValueMapping> valueMappings, boolean restrictToDefinedMappings)

Method Summary

Modifier and Type	Method and Description
void	applyIgnoreAll(MappingOptions inherited, SourceMethod method, FormattingMessager messager, TypeFactory typeFactory, AccessorNamingUtils accessorNaming)
void	applyInheritedOptions(MappingOptions inherited, boolean isInverse, SourceMethod method, FormattingMessager messager, TypeFactory typeFactory, AccessorNamingUtils accessorNaming) Merges in all the mapping options configured, giving the already defined options precedence.
List<String>	collectNestedDependsOn()
static MappingOptions	empty() creates empty mapping options
static MappingOptions	forMappingsOnly(Map<String,List<Mapping>> mappings, boolean restrictToDefinedMappings) creates mapping options with only regular mappings
static MappingOptions	forMappingsOnly(Map<String,List<Mapping>> mappings, boolean restrictToDefinedMappings, boolean forForgedMethods) creates mapping options with only regular mappings
BeanMapping	getBeanMapping()
IterableMapping	getIterableMapping()
MapMapping	getMapMapping()
Map<String,List<Mapping>>	getMappings()
List<ValueMapping>	getValueMappings()
boolean	hasNestedTargetReferences() Check there are nested target references for this mapping options.
void	initWithParameter(Parameter sourceParameter) Initializes the underlying mappings with a new property.
boolean	isFullyInitialized()
boolean	isRestrictToDefinedMappings()
void	markAsFullyInitialized()
void	setBeanMapping(BeanMapping beanMapping)
void	setIterableMapping(IterableMapping iterableMapping)
void	setMapMapping(MapMapping mapMapping)
void	setMappings(Map<String,List<Mapping>> mappings)
void	setValueMappings(List<ValueMapping> valueMappings)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingOptions

public MappingOptions(Map<String,List<Mapping>> mappings,
                      IterableMapping iterableMapping,
                      MapMapping mapMapping,
                      BeanMapping beanMapping,
                      List<ValueMapping> valueMappings,
                      boolean restrictToDefinedMappings)

Method Detail

empty

public static MappingOptions empty()

creates empty mapping options

Returns:

empty mapping options

forMappingsOnly

public static MappingOptions forMappingsOnly(Map<String,List<Mapping>> mappings,
                                             boolean restrictToDefinedMappings)

creates mapping options with only regular mappings

Parameters:

mappings - regular mappings to add

restrictToDefinedMappings - whether to restrict the mappings only to the defined mappings

Returns:

MappingOptions with only regular mappings

forMappingsOnly

public static MappingOptions forMappingsOnly(Map<String,List<Mapping>> mappings,
                                             boolean restrictToDefinedMappings,
                                             boolean forForgedMethods)

creates mapping options with only regular mappings

Parameters:

mappings - regular mappings to add

restrictToDefinedMappings - whether to restrict the mappings only to the defined mappings

forForgedMethods - whether the mappings are for forged methods

Returns:

MappingOptions with only regular mappings

getMappings

public Map<String,List<Mapping>> getMappings()

Returns:

the Mappings configured for this method, keyed by target property name. Only for enum mapping methods a target will be mapped by several sources. TODO. Remove the value list when 2.0

hasNestedTargetReferences

public boolean hasNestedTargetReferences()

Check there are nested target references for this mapping options.

Returns:

boolean, true if there are nested target references

collectNestedDependsOn

public List<String> collectNestedDependsOn()

Returns:

all dependencies to other properties the contained mappings are dependent on

initWithParameter

public void initWithParameter(Parameter sourceParameter)

Initializes the underlying mappings with a new property. Specifically used in in combination with forged methods where the new parameter name needs to be established at a later moment.

Parameters:

sourceParameter - the new source parameter

getIterableMapping

public IterableMapping getIterableMapping()

getMapMapping

public MapMapping getMapMapping()

getBeanMapping

public BeanMapping getBeanMapping()

getValueMappings

public List<ValueMapping> getValueMappings()

setMappings

public void setMappings(Map<String,List<Mapping>> mappings)

setIterableMapping

public void setIterableMapping(IterableMapping iterableMapping)

setMapMapping

public void setMapMapping(MapMapping mapMapping)

setBeanMapping

public void setBeanMapping(BeanMapping beanMapping)

setValueMappings

public void setValueMappings(List<ValueMapping> valueMappings)

isFullyInitialized

public boolean isFullyInitialized()

Returns:

the true, iff the options have been fully initialized by applying all available inheritance options

markAsFullyInitialized

public void markAsFullyInitialized()

applyInheritedOptions

public void applyInheritedOptions(MappingOptions inherited,
                                  boolean isInverse,
                                  SourceMethod method,
                                  FormattingMessager messager,
                                  TypeFactory typeFactory,
                                  AccessorNamingUtils accessorNaming)

Merges in all the mapping options configured, giving the already defined options precedence.

Parameters:

inherited - the options to inherit, may be null

isInverse - if true, the specified options are from an inverse method

method - the source method

messager - the messager

typeFactory - the type factory

accessorNaming - the accessor naming utils

applyIgnoreAll

public void applyIgnoreAll(MappingOptions inherited,
                           SourceMethod method,
                           FormattingMessager messager,
                           TypeFactory typeFactory,
                           AccessorNamingUtils accessorNaming)

isRestrictToDefinedMappings

public boolean isRestrictToDefinedMappings()