ninja.leaping.configurate.objectmapping

Class ObjectMapper<T>

java.lang.Object

ninja.leaping.configurate.objectmapping.ObjectMapper<T>

Type Parameters:

T - The type to work with

public class ObjectMapper<T>
extends Object

This is the object mapper. It handles conversion between configuration nodes and fields annotated with Setting in objects. Values in the node not used by the mapped object will be preserved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ObjectMapper.BoundInstance Represents an object mapper bound to a certain instance of the object
protected static class	ObjectMapper.FieldData Holder for field-specific information

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectMapper(Class<T> clazz) Create a new object mapper of a given type

Method Summary

Modifier and Type	Method and Description
ObjectMapper.BoundInstance	bind(T instance) Return a view on this mapper that is bound to a single object instance
ObjectMapper.BoundInstance	bindToNew() Returns a view on this mapper that is bound to a newly created object instance
boolean	canCreateInstances() Returns whether this object mapper can create new object instances.
protected void	collectFields(Map<String,ObjectMapper.FieldData> cachedFields, Class<? super T> clazz)
protected T	constructObject() Create a new instance of an object of the appropriate type.
static <T> ObjectMapper<T>	forClass(Class<T> clazz) Create a new object mapper that can work with objects of the given class
static <T> ObjectMapper.BoundInstance	forObject(T obj)
Class<T>	getMappedType()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectMapper

protected ObjectMapper(Class<T> clazz)
                throws ObjectMappingException

Create a new object mapper of a given type

Parameters:

clazz - The type this object mapper will work with

Throws:

ObjectMappingException - if the provided class is in someway invalid

Method Detail

forClass

public static <T> ObjectMapper<T> forClass(Class<T> clazz)
                                    throws ObjectMappingException

Create a new object mapper that can work with objects of the given class

Type Parameters:

T - The type

Parameters:

clazz - The type of object

Returns:

An appropriate object mapper instance. May be shared with other users.

Throws:

ObjectMappingException - If invalid annotated fields are presented

forObject

public static <T> ObjectMapper.BoundInstance forObject(T obj)
                                                throws ObjectMappingException

Throws:

ObjectMappingException

collectFields

protected void collectFields(Map<String,ObjectMapper.FieldData> cachedFields,
                             Class<? super T> clazz)
                      throws ObjectMappingException

Throws:

ObjectMappingException

constructObject

protected T constructObject()
                     throws ObjectMappingException

Create a new instance of an object of the appropriate type. This method is not responsible for any population.

Returns:

The new object instance

Throws:

ObjectMappingException - If constructing a new instance was not possible

canCreateInstances

public boolean canCreateInstances()

Returns whether this object mapper can create new object instances. This may be false if the provided class has no zero-argument constructors.

Returns:

Whether new object instances can be created

bind

public ObjectMapper.BoundInstance bind(T instance)

Return a view on this mapper that is bound to a single object instance

Parameters:

instance - The instance to bind to

Returns:

A view referencing this mapper and the bound instance

bindToNew

public ObjectMapper.BoundInstance bindToNew()
                                     throws ObjectMappingException

Returns a view on this mapper that is bound to a newly created object instance

Returns:

Bound mapper attached to a new object instance

Throws:

ObjectMappingException - If the object could not be constructed correctly

See Also:

bind(Object)

getMappedType

public Class<T> getMappedType()