MappedField (Morphia 1.2.1-SNAPSHOT API)

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

Direct Known Subclasses:

EphemeralMappedField
```
public class MappedField
extends Object
```
Represents the mapping of this field to/from mongodb (name, list)

Author:

Scott Hernandez

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(Class<? extends Annotation> clazz)` Adds the annotation, if it exists on the field.
`void`	`addAnnotation(Class<? extends Annotation> clazz, Annotation ann)` Adds the annotation, if it exists on the field.
`static void`	`addInterestingAnnotation(Class<? extends Annotation> annotation)` Adds an annotation for Morphia to retain when mapping.
`protected void`	`discover(Mapper mapper)` Discovers interesting (that we care about) things about the field.
`protected void`	`discoverType(Mapper mapper)`
`<T extends Annotation> T`	`getAnnotation(Class<T> clazz)`
`Map<Class<? extends Annotation>,Annotation>`	`getAnnotations()`
`Class`	`getConcreteType()`
`Constructor`	`getCTor()`
`Object`	`getDbObjectValue(DBObject dbObj)`
`Class`	`getDeclaringClass()`
`Field`	`getField()`
`Object`	`getFieldValue(Object instance)` Gets the value of the field mapped on the instance given.
`String`	`getFirstFieldName(DBObject dbObj)` Gets the field name to use when converting from a DBObject
`String`	`getFullName()`
`String`	`getJavaFieldName()`
`List<String>`	`getLoadNames()`
`Class`	`getMapKeyClass()` If the underlying java type is a map then it returns T from Map
`protected String`	`getMappedFieldName()`
`String`	`getNameToStore()`
`Class`	`getSubClass()` If the java field is a list/array/map then the sub-type T is returned (ex.
`Type`	`getSubType()` If the java field is a list/array/map then the sub-type T is returned (ex.
`Class`	`getType()`
`List<MappedField>`	`getTypeParameters()`
`boolean`	`hasAnnotation(Class ann)` Indicates whether the annotation is present in the mapping (does not check the java field annotations, just the ones discovered)
`boolean`	`isArray()`
`boolean`	`isMap()`
`boolean`	`isMultipleValues()`
`boolean`	`isReference()`
`boolean`	`isSet()`
`boolean`	`isSingleValue()`
`boolean`	`isTransient()`
`boolean`	`isTypeMongoCompatible()`
`Annotation`	`putAnnotation(Annotation ann)` Adds the annotation even if not on the declared class/field.
`void`	`setFieldValue(Object instance, Object value)` Sets the value for the java field
`protected Class`	`toClass(Type t)`
`String`	`toString()`

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

- Method Detail
  - addInterestingAnnotation
```
public static void addInterestingAnnotation(Class<? extends Annotation> annotation)
```
    Adds an annotation for Morphia to retain when mapping.
    
    Parameters:
    
    annotation - the type to retain
  - addAnnotation
```
public void addAnnotation(Class<? extends Annotation> clazz)
```
    Adds the annotation, if it exists on the field.
    
    Parameters:
    
    clazz - the annotation to add
  - addAnnotation
```
public void addAnnotation(Class<? extends Annotation> clazz,
                          Annotation ann)
```
    Adds the annotation, if it exists on the field.
    
    Parameters:
    
    clazz - type of the annotation
    
    ann - the annotation
  - getAnnotation
```
public <T extends Annotation> T getAnnotation(Class<T> clazz)
```
    Type Parameters:
    
    T - the type of the annotation
    
    Parameters:
    
    clazz - the annotation to search for
    
    Returns:
    
    the annotation instance if it exists on this field
  - getAnnotations
```
public Map<Class<? extends Annotation>,Annotation> getAnnotations()
```
    Returns:
    
    the annotations found while mapping
  - getCTor
```
public Constructor getCTor()
```
    Returns:
    
    a constructor for the type represented by the field
  - getConcreteType
```
public Class getConcreteType()
```
    Returns:
    
    the concrete type of the MappedField
  - getDbObjectValue
```
public Object getDbObjectValue(DBObject dbObj)
```
    Parameters:
    
    dbObj - the DBObject get the value from
    
    Returns:
    
    the value from best mapping of this field
  - getDeclaringClass
```
public Class getDeclaringClass()
```
    Returns:
    
    the declaring class of the java field
  - getField
```
public Field getField()
```
    Returns:
    
    the underlying java field
  - getFieldValue
```
public Object getFieldValue(Object instance)
```
    Gets the value of the field mapped on the instance given.
    
    Parameters:
    
    instance - the instance to use
    
    Returns:
    
    the value stored in the java field
  - getFirstFieldName
```
public String getFirstFieldName(DBObject dbObj)
```
    Gets the field name to use when converting from a DBObject
    
    Parameters:
    
    dbObj - the DBObject to scan for alternate names
    
    Returns:
    
    the value of this field mapped from the DBObject
    
    See Also:
    
    AlsoLoad
  - getFullName
```
public String getFullName()
```
    Returns:
    
    the full name of the class plus java field name
  - getJavaFieldName
```
public String getJavaFieldName()
```
    Returns:
    
    the name of the java field, as declared on the class
  - getLoadNames
```
public List<String> getLoadNames()
```
    Returns:
    
    the name of the field's (key)name for mongodb, in order of loading.
  - getMapKeyClass
```
public Class getMapKeyClass()
```
    If the underlying java type is a map then it returns T from Map
    
    Returns:
    
    the type of the map key
  - getNameToStore
```
public String getNameToStore()
```
    Returns:
    
    the name of the field's (key)name for mongodb
  - getSubClass
```
public Class getSubClass()
```
    If the java field is a list/array/map then the sub-type T is returned (ex. List, T[], Map
    
    Returns:
    
    the parameterized type of the field
  - getSubType
```
public Type getSubType()
```
    If the java field is a list/array/map then the sub-type T is returned (ex. List, T[], Map
    
    Returns:
    
    the parameterized type of the field
  - isTransient
```
public boolean isTransient()
```
    Returns:
    
    true if this field is marked as transient
  - getType
```
public Class getType()
```
    Returns:
    
    the type of the underlying java field
  - getTypeParameters
```
public List<MappedField> getTypeParameters()
```
    Returns:
    
    the type parameters defined on the field
  - hasAnnotation
```
public boolean hasAnnotation(Class ann)
```
    Indicates whether the annotation is present in the mapping (does not check the java field annotations, just the ones discovered)
    
    Parameters:
    
    ann - the annotation to search for
    
    Returns:
    
    true if the annotation was found
  - isArray
```
public boolean isArray()
```
    Returns:
    
    true if the MappedField is an array
  - isMap
```
public boolean isMap()
```
    Returns:
    
    true if the MappedField is a Map
  - isMultipleValues
```
public boolean isMultipleValues()
```
    Returns:
    
    true if this field is a container type such as a List, Map, Set, or array
  - isReference
```
public boolean isReference()
```
    Returns:
    
    true if this field is a reference to a foreign document
    
    See Also:
    
    Reference, Key, DBRef
  - isSet
```
public boolean isSet()
```
    Returns:
    
    true if the MappedField is a Set
  - isSingleValue
```
public boolean isSingleValue()
```
    Returns:
    
    true if this field is not a container type such as a List, Map, Set, or array
  - isTypeMongoCompatible
```
public boolean isTypeMongoCompatible()
```
    Returns:
    
    true if type is understood by MongoDB and the driver
  - putAnnotation
```
public Annotation putAnnotation(Annotation ann)
```
    Adds the annotation even if not on the declared class/field.
    
    Parameters:
    
    ann - the annotation to add
    
    Returns:
    
    ann the annotation
  - setFieldValue
```
public void setFieldValue(Object instance,
                          Object value)
```
    Sets the value for the java field
    
    Parameters:
    
    instance - the instance to update
    
    value - the value to set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - discover
```
protected void discover(Mapper mapper)
```
    Discovers interesting (that we care about) things about the field.
  - discoverType
```
protected void discoverType(Mapper mapper)
```
  - getMappedFieldName
```
protected String getMappedFieldName()
```
    Returns:
    
    the name of the field's key-name for mongodb
  - toClass
```
protected Class toClass(Type t)
```

Class MappedField

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addInterestingAnnotation

addAnnotation

addAnnotation

getAnnotation

getAnnotations

getCTor

getConcreteType

getDbObjectValue

getDeclaringClass

getField

getFieldValue

getFirstFieldName

getFullName

getJavaFieldName

getLoadNames

getMapKeyClass

getNameToStore

getSubClass

getSubType

isTransient

getType

getTypeParameters

hasAnnotation

isArray

isMap

isMultipleValues

isReference

isSet

isSingleValue

isTypeMongoCompatible

putAnnotation

setFieldValue

toString

discover

discoverType

getMappedFieldName

toClass