MappingContext (Orika - core 1.5.0 API)

java.lang.Object
- ma.glasnost.orika.MappingContext

Direct Known Subclasses:

NonCyclicMappingContext
```
public class MappingContext
extends Object
```
MappingContext provides storage for information shared among the various mapping objects for a given mapping request.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MappingContext.Factory` Factory constructs instances of the base MappingContext
`static class`	`MappingContext.StackElement`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`capturesFieldContext`
`protected boolean`	`containsCycle`
`protected int`	`depth`
`protected List<Object[]>`	`fieldMappingStack`
`protected Map<Object,Object>`	`globalProperties`
`protected boolean`	`isNew`
`protected List<Map<MapperKey,ClassMap<?,?>>>`	`mappersSeen`
`protected Map<Type<?>,Type<?>>`	`mapping`
`protected Map<Object,Object>`	`properties`
`protected Type<?>`	`resolvedDestinationType`
`protected Type<?>`	`resolvedSourceType`
`protected MappingStrategy`	`resolvedStrategy`
`protected OpenIntObjectHashMap`	`typeCache`

Constructor Summary

Constructors
Constructor and Description

MappingContext(Map<Object,Object> globalProperties)
Constructs a new MappingContext with the specified (immutable) global properties;

Constructors
Constructor and Description
`MappingContext(Map<Object,Object> globalProperties)` Constructs a new MappingContext with the specified (immutable) global properties;

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`beginMapping()` Deprecated. This variant exists for backwards compatibility only; if overriding, override `beginMapping(Type, Object, Type, Object)` instead.
`void`	`beginMapping(Type<?> sourceType, Object source, Type<?> destType, Object dest)` Deprecated. This variant exists for backwards compatibility only; if overriding, override `#beginMapping(Type, String, Object, Type, String, Object)` instead.
`void`	`beginMappingField(String sourceName, Type<?> sourceType, Object source, String destName, Type<?> destType, Object dest)` Mark the start of mapping a particular field
`<S,D> void`	`cacheMappedObject(S source, Type<Object> destinationType, D destination)` Caches an object instance which has been mapped for a particular source instance and destination type in this mapping context; this will later be referenced in avoiding infinite recursion mapping the same object.
`boolean`	`containsCycle()`
`void`	`containsCycle(boolean containsCycle)` Sets whether this MappingContext needs to guard against cycles when mapping the current object graph; specifying `false` when applicable can lend improved performance.
`void`	`endMapping()` Mark the end of a particular mapping
`void`	`endMappingField()`
`<S,D> Type<? extends D>`	`getConcreteClass(Type<S> sourceType, Type<D> destinationType)` Searches for a concrete class that has been registered for the given abstract class or interface within this mapping session.
`int`	`getDepth()`
`String[]`	`getDestinationExpressionPaths()`
`Object[]`	`getDestinationObjects()`
`Type[]`	`getDestinationTypePaths()`
`String`	`getFullyQualifiedDestinationPath()`
`String`	`getFullyQualifiedSourcePath()`
`<D> D`	`getMappedObject(Object source, Type<?> destinationType)` Looks for an object which has already been mapped for the source and destination type in this context.
`ClassMap<?,?>`	`getMapperGeneration(MapperKey mapperKey)` Looks up a ClassMap among the mappers generated with this mapping context
`Object`	`getProperty(Object key)` Get a property set on the current mapping context; individual properties set on this context instance are checked first, followed by global properties.
`Type<?>`	`getResolvedDestinationType()`
`Type<?>`	`getResolvedSourceType()`
`MappingStrategy`	`getResolvedStrategy()`
`String[]`	`getSourceExpressionPaths()`
`Object[]`	`getSourceObjects()`
`Type[]`	`getSourceTypePaths()`
`void`	`registerConcreteClass(Type<?> subjectClass, Type<?> concreteClass)` Registers a concrete class to be used for the given abstract class or interface within this mapping session only.
`void`	`registerMapperGeneration(ClassMap<?,?> classMap)` Registers a ClassMap marking it as mapped within the current context;
`void`	`reset()` Resets this context instance, in preparation for use by another mapping request
`void`	`setProperty(Object key, Object value)` Sets an instance property on this MappingContext
`void`	`setResolvedDestinationType(Type<?> resolvedDestinationType)`
`void`	`setResolvedSourceType(Type<?> resolvedSourceType)`
`void`	`setResolvedStrategy(MappingStrategy resolvedStrategy)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mapping
```
protected final Map<Type<?>,Type<?>> mapping
```
  - typeCache
```
protected final OpenIntObjectHashMap typeCache
```
  - mappersSeen
```
protected List<Map<MapperKey,ClassMap<?,?>>> mappersSeen
```
  - properties
```
protected Map<Object,Object> properties
```
  - globalProperties
```
protected Map<Object,Object> globalProperties
```
  - isNew
```
protected boolean isNew
```
  - containsCycle
```
protected boolean containsCycle
```
  - depth
```
protected int depth
```
  - resolvedSourceType
```
protected Type<?> resolvedSourceType
```
  - resolvedDestinationType
```
protected Type<?> resolvedDestinationType
```
  - resolvedStrategy
```
protected MappingStrategy resolvedStrategy
```
  - fieldMappingStack
```
protected List<Object[]> fieldMappingStack
```
  - capturesFieldContext
```
protected boolean capturesFieldContext
```
- Constructor Detail
  - MappingContext
```
public MappingContext(Map<Object,Object> globalProperties)
```
    Constructs a new MappingContext with the specified (immutable) global properties;
    
    Parameters:
    
    globalProperties -
- Method Detail
  - containsCycle
```
public void containsCycle(boolean containsCycle)
```
    Sets whether this MappingContext needs to guard against cycles when mapping the current object graph; specifying false when applicable can lend improved performance.
    
    Parameters:
    
    containsCycle -
  - containsCycle
```
public boolean containsCycle()
```
    Returns:
    
    true if this mapping context is watching for cycles in the object graph
  - getDepth
```
public int getDepth()
```
    Returns:
    
    the current mapping depth
  - getConcreteClass
```
public <S,D> Type<? extends D> getConcreteClass(Type<S> sourceType,
                                                Type<D> destinationType)
```
    Searches for a concrete class that has been registered for the given abstract class or interface within this mapping session.
    
    Parameters:
    
    sourceType -
    
    destinationType -
    
    Returns:
    
    a concrete class that has been registered for the given abstract class or interface within this mapping session, if any
  - registerConcreteClass
```
public void registerConcreteClass(Type<?> subjectClass,
                                  Type<?> concreteClass)
```
    Registers a concrete class to be used for the given abstract class or interface within this mapping session only.
    
    Parameters:
    
    subjectClass -
    
    concreteClass -
  - cacheMappedObject
```
public <S,D> void cacheMappedObject(S source,
                                    Type<Object> destinationType,
                                    D destination)
```
    Caches an object instance which has been mapped for a particular source instance and destination type in this mapping context; this will later be referenced in avoiding infinite recursion mapping the same object.
    
    Parameters:
    
    source -
    
    destinationType -
    
    destination -
  - getMappedObject
```
public <D> D getMappedObject(Object source,
                             Type<?> destinationType)
```
    Looks for an object which has already been mapped for the source and destination type in this context.
    
    Parameters:
    
    source -
    
    destinationType -
    
    Returns:
    
    the mapped object, or null if none exists for the source instance and destination type
  - registerMapperGeneration
```
public void registerMapperGeneration(ClassMap<?,?> classMap)
```
    Registers a ClassMap marking it as mapped within the current context;
    
    Parameters:
    
    classMap -
  - getMapperGeneration
```
public ClassMap<?,?> getMapperGeneration(MapperKey mapperKey)
```
    Looks up a ClassMap among the mappers generated with this mapping context
    
    Parameters:
    
    mapperKey -
    
    Returns:
    
    the ClassMap for which a Mapper was generated in this context, if any
  - beginMapping
```
@Deprecated
public void beginMapping()
```
    Deprecated. This variant exists for backwards compatibility only; if overriding, override beginMapping(Type, Object, Type, Object) instead.
    
    Mark the beginning of a particular mapping
  - beginMapping
```
@Deprecated
public void beginMapping(Type<?> sourceType,
                                     Object source,
                                     Type<?> destType,
                                     Object dest)
```
    Deprecated. This variant exists for backwards compatibility only; if overriding, override #beginMapping(Type, String, Object, Type, String, Object) instead.
    
    Mark the beginning of a particular mapping
    
    Parameters:
    
    sourceType - the type of the source object being mapped
    
    source - the source object being mapped
    
    destType - the type of the destination object being mapped into
    
    dest - the destination object being mapped into
  - beginMappingField
```
public void beginMappingField(String sourceName,
                              Type<?> sourceType,
                              Object source,
                              String destName,
                              Type<?> destType,
                              Object dest)
```
    Mark the start of mapping a particular field
    
    Parameters:
    
    sourceType - the type of the source field
    
    sourceName - the name of the source field
    
    source - the source object being mapped
    
    destType - the type of the destination object being mapped into
    
    destName - the name of the destination field
    
    dest - the destination object being mapped into
  - endMappingField
```
public void endMappingField()
```
  - getFullyQualifiedSourcePath
```
public String getFullyQualifiedSourcePath()
```
    Returns:
    
    the qualified property expression describing the source field currently being mapped
  - getSourceExpressionPaths
```
public String[] getSourceExpressionPaths()
```
    Returns:
    
    an array of expressions describing the path to the source field being currently mapped; each array element contains the expression value of the field as referenced within the individual class-map.
  - getSourceObjects
```
public Object[] getSourceObjects()
```
    Returns:
    
    an array of the source object values on the current stack, where the last element of the array is the value of the source field being currently mapped
  - getSourceTypePaths
```
public Type[] getSourceTypePaths()
```
    Returns:
    
    an array of types representing the path to the type of the source field being currently mapped; this represents each type in the chain of mappers called to map the current field.
  - getFullyQualifiedDestinationPath
```
public String getFullyQualifiedDestinationPath()
```
    Returns:
    
    the qualified property expression describing the destination field currently being mapped
  - getDestinationExpressionPaths
```
public String[] getDestinationExpressionPaths()
```
    Returns:
    
    an array of expressions describing the path to the source field being currently mapped; each array element contains the expression value of the field as referenced within the individual class-map.
  - getDestinationObjects
```
public Object[] getDestinationObjects()
```
    Returns:
    
    an array of the destination object values on the current stack, where the last element of the array is the value of the destination field being currently mapped
  - getDestinationTypePaths
```
public Type[] getDestinationTypePaths()
```
    Returns:
    
    an array of types representing the path to the type of the destination field being currently mapped; this represents each type in the chain of mappers called to map the current field.
  - endMapping
```
public void endMapping()
```
    Mark the end of a particular mapping
  - reset
```
public void reset()
```
    Resets this context instance, in preparation for use by another mapping request
  - setProperty
```
public void setProperty(Object key,
                        Object value)
```
    Sets an instance property on this MappingContext
    
    Parameters:
    
    key -
    
    value -
  - getProperty
```
public Object getProperty(Object key)
```
    Get a property set on the current mapping context; individual properties set on this context instance are checked first, followed by global properties.
    
    Parameters:
    
    key -
    
    Returns:
    
    the object stored under the specified key as a instance or global property.
  - getResolvedSourceType
```
public Type<?> getResolvedSourceType()
```
    Returns:
    
    the resolvedSourceType in the current context
  - setResolvedSourceType
```
public void setResolvedSourceType(Type<?> resolvedSourceType)
```
    Parameters:
    
    resolvedSourceType - the resolvedSourceType to set
  - getResolvedDestinationType
```
public Type<?> getResolvedDestinationType()
```
    Returns:
    
    the resolvedDestinationType in the current context
  - setResolvedDestinationType
```
public void setResolvedDestinationType(Type<?> resolvedDestinationType)
```
    Parameters:
    
    resolvedDestinationType - the resolvedDestinationType to set
  - getResolvedStrategy
```
public MappingStrategy getResolvedStrategy()
```
    Returns:
    
    the resolved strategy in the current context
  - setResolvedStrategy
```
public void setResolvedStrategy(MappingStrategy resolvedStrategy)
```
    Parameters:
    
    resolvedStrategy - the mapping strategy to set

Class MappingContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mapping

typeCache

mappersSeen

properties

globalProperties

isNew

containsCycle

depth

resolvedSourceType

resolvedDestinationType

resolvedStrategy

fieldMappingStack

capturesFieldContext

Constructor Detail

MappingContext

Method Detail

containsCycle

containsCycle

getDepth

getConcreteClass

registerConcreteClass

cacheMappedObject

getMappedObject

registerMapperGeneration

getMapperGeneration

beginMapping

beginMapping

beginMappingField

endMappingField

getFullyQualifiedSourcePath

getSourceExpressionPaths

getSourceObjects

getSourceTypePaths

getFullyQualifiedDestinationPath

getDestinationExpressionPaths

getDestinationObjects

getDestinationTypePaths

endMapping

reset

setProperty

getProperty

getResolvedSourceType

setResolvedSourceType

getResolvedDestinationType

setResolvedDestinationType

getResolvedStrategy

setResolvedStrategy