MapperOptions (Morphia 1.2.1-SNAPSHOT API)

java.lang.Object
- org.mongodb.morphia.mapping.MapperOptions

```
public class MapperOptions
extends Object
```
Options to control mapping behavior.

Author:

Scott Hernandez

Constructor Summary

Constructors
Constructor and Description

MapperOptions()
Creates a default options instance.

MapperOptions(MapperOptions options)
Copy Constructor

Constructors
Constructor and Description
`MapperOptions()` Creates a default options instance.
`MapperOptions(MapperOptions options)` Copy Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`EntityCacheFactory`	`getCacheFactory()`
`DatastoreProvider`	`getDatastoreProvider()` Deprecated. unused
`CustomMapper`	`getDefaultMapper()`
`CustomMapper`	`getEmbeddedMapper()`
`ObjectFactory`	`getObjectFactory()`
`CustomMapper`	`getReferenceMapper()`
`CustomMapper`	`getValueMapper()`
`boolean`	`isActLikeSerializer()` Deprecated. this is actually the default and proper behavior. this setting is redundant
`boolean`	`isCacheClassLookups()`
`boolean`	`isIgnoreFinals()`
`boolean`	`isMapSubPackages()`
`boolean`	`isStoreEmpties()`
`boolean`	`isStoreNulls()`
`boolean`	`isUseLowerCaseCollectionNames()`
`void`	`setActLikeSerializer(boolean actLikeSerializer)` Deprecated. this is actually the default and proper behavior. this setting is redundant
`void`	`setCacheClassLookups(boolean cacheClassLookups)` Sets whether Morphia should cache name -> Class lookups
`void`	`setCacheFactory(EntityCacheFactory cacheFactory)` Sets the factory to create an EntityCache
`void`	`setDatastoreProvider(DatastoreProvider datastoreProvider)` Deprecated. unused
`void`	`setDefaultMapper(CustomMapper pDefaultMapper)` Sets the mapper to use for top level entities
`void`	`setEmbeddedMapper(CustomMapper pEmbeddedMapper)` Sets the mapper to use for embedded entities
`void`	`setIgnoreFinals(boolean ignoreFinals)` Controls if final fields are stored.
`void`	`setMapSubPackages(boolean mapSubPackages)` Controls if classes from sub-packages should be mapped.
`void`	`setObjectFactory(ObjectFactory objectFactory)` Sets the ObjectFactory to use when instantiating entity classes.
`void`	`setReferenceMapper(CustomMapper pReferenceMapper)` Sets the mapper to use for references
`void`	`setStoreEmpties(boolean storeEmpties)` Controls if Morphia should store empty values for lists/maps/sets/arrays
`void`	`setStoreNulls(boolean storeNulls)` Controls if null are stored.
`void`	`setUseLowerCaseCollectionNames(boolean useLowerCaseCollectionNames)` Controls if default entity collection name should be lowercase.
`void`	`setValueMapper(CustomMapper pValueMapper)` Sets the mapper to use when processing values

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

- Constructor Detail
  - MapperOptions
```
public MapperOptions()
```
    Creates a default options instance.
  - MapperOptions
```
public MapperOptions(MapperOptions options)
```
    Copy Constructor
    
    Parameters:
    
    options - the MapperOptions to copy
- Method Detail
  - getCacheFactory
```
public EntityCacheFactory getCacheFactory()
```
    Returns:
    
    the factory to create an EntityCache
  - setCacheFactory
```
public void setCacheFactory(EntityCacheFactory cacheFactory)
```
    Sets the factory to create an EntityCache
    
    Parameters:
    
    cacheFactory - the factory
  - getDatastoreProvider
```
public DatastoreProvider getDatastoreProvider()
```
    Deprecated. unused
    
    Returns:
    
    the DatastoreProvider Morphia should use
  - setDatastoreProvider
```
public void setDatastoreProvider(DatastoreProvider datastoreProvider)
```
    Deprecated. unused
    
    Sets the DatastoreProvider Morphia should use
    
    Parameters:
    
    datastoreProvider - the DatastoreProvider to use
  - getDefaultMapper
```
public CustomMapper getDefaultMapper()
```
    Returns:
    
    the mapper to use for top level entities
  - setDefaultMapper
```
public void setDefaultMapper(CustomMapper pDefaultMapper)
```
    Sets the mapper to use for top level entities
    
    Parameters:
    
    pDefaultMapper - the mapper to use
  - getEmbeddedMapper
```
public CustomMapper getEmbeddedMapper()
```
    Returns:
    
    the mapper to use for embedded entities
  - setEmbeddedMapper
```
public void setEmbeddedMapper(CustomMapper pEmbeddedMapper)
```
    Sets the mapper to use for embedded entities
    
    Parameters:
    
    pEmbeddedMapper - the mapper to use
  - getObjectFactory
```
public ObjectFactory getObjectFactory()
```
    Returns:
    
    the factory to use when creating new instances
  - setObjectFactory
```
public void setObjectFactory(ObjectFactory objectFactory)
```
    Sets the ObjectFactory to use when instantiating entity classes. The default factory is a simple reflection based factory but this could be used, e.g., to provide a Guice-based factory such as what morphia-guice provides.
    
    Parameters:
    
    objectFactory - the factory to use
  - getReferenceMapper
```
public CustomMapper getReferenceMapper()
```
    Returns:
    
    the mapper to use for references
    
    See Also:
    
    Reference
  - setReferenceMapper
```
public void setReferenceMapper(CustomMapper pReferenceMapper)
```
    Sets the mapper to use for references
    
    Parameters:
    
    pReferenceMapper - the mapper to use
    
    See Also:
    
    Reference
  - getValueMapper
```
public CustomMapper getValueMapper()
```
    Returns:
    
    the mapper to use when processing values
  - setValueMapper
```
public void setValueMapper(CustomMapper pValueMapper)
```
    Sets the mapper to use when processing values
    
    Parameters:
    
    pValueMapper - the mapper to use
  - isActLikeSerializer
```
public boolean isActLikeSerializer()
```
    Deprecated. this is actually the default and proper behavior. this setting is redundant
    
    Returns:
    
    true if Morphia should ignore transient fields
  - setActLikeSerializer
```
public void setActLikeSerializer(boolean actLikeSerializer)
```
    Deprecated. this is actually the default and proper behavior. this setting is redundant
    
    Instructs Morphia to follow JDK serialization semantics and ignore values marked up with the transient keyword
    
    Parameters:
    
    actLikeSerializer - true if Morphia should ignore transient fields
  - isCacheClassLookups
```
public boolean isCacheClassLookups()
```
    Returns:
    
    true if Morphia should cache name -> Class lookups
  - setCacheClassLookups
```
public void setCacheClassLookups(boolean cacheClassLookups)
```
    Sets whether Morphia should cache name -> Class lookups
    
    Parameters:
    
    cacheClassLookups - true if the lookup results should be cached
  - isIgnoreFinals
```
public boolean isIgnoreFinals()
```
    Returns:
    
    true if Morphia should ignore final fields
  - setIgnoreFinals
```
public void setIgnoreFinals(boolean ignoreFinals)
```
    Controls if final fields are stored.
    
    Parameters:
    
    ignoreFinals - true if Morphia should ignore final fields
  - isStoreEmpties
```
public boolean isStoreEmpties()
```
    Returns:
    
    true if Morphia should store empty values for lists/maps/sets/arrays
  - setStoreEmpties
```
public void setStoreEmpties(boolean storeEmpties)
```
    Controls if Morphia should store empty values for lists/maps/sets/arrays
    
    Parameters:
    
    storeEmpties - true if Morphia should store empty values for lists/maps/sets/arrays
  - isStoreNulls
```
public boolean isStoreNulls()
```
    Returns:
    
    true if Morphia should store null values
  - setStoreNulls
```
public void setStoreNulls(boolean storeNulls)
```
    Controls if null are stored.
    
    Parameters:
    
    storeNulls - true if Morphia should store null values
  - isUseLowerCaseCollectionNames
```
public boolean isUseLowerCaseCollectionNames()
```
    Returns:
    
    true if Morphia should use lower case values when calculating collection names
  - setUseLowerCaseCollectionNames
```
public void setUseLowerCaseCollectionNames(boolean useLowerCaseCollectionNames)
```
    Controls if default entity collection name should be lowercase.
    
    Parameters:
    
    useLowerCaseCollectionNames - true if Morphia should use lower case values when calculating collection names
  - isMapSubPackages
```
public boolean isMapSubPackages()
```
    Returns:
    
    true if Morphia should map classes from the sub-packages as well
  - setMapSubPackages
```
public void setMapSubPackages(boolean mapSubPackages)
```
    Controls if classes from sub-packages should be mapped.
    
    Parameters:
    
    mapSubPackages - true if Morphia should map classes from the sub-packages as well

Class MapperOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapperOptions

MapperOptions

Method Detail

getCacheFactory

setCacheFactory

getDatastoreProvider

setDatastoreProvider

getDefaultMapper

setDefaultMapper

getEmbeddedMapper

setEmbeddedMapper

getObjectFactory

setObjectFactory

getReferenceMapper

setReferenceMapper

getValueMapper

setValueMapper

isActLikeSerializer

setActLikeSerializer

isCacheClassLookups

setCacheClassLookups

isIgnoreFinals

setIgnoreFinals

isStoreEmpties

setStoreEmpties

isStoreNulls

setStoreNulls

isUseLowerCaseCollectionNames

setUseLowerCaseCollectionNames

isMapSubPackages

setMapSubPackages