Package ninja.leaping.configurate.objectmapping

Class ObjectMapper.BoundInstance

java.lang.Object

ninja.leaping.configurate.objectmapping.ObjectMapper.BoundInstance

Enclosing class:

ObjectMapper<T>

public class ObjectMapper.BoundInstance
extends Object

Represents an object mapper bound to a certain instance of the object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BoundInstance(T boundInstance)

Method Summary

Modifier and Type	Method	Description
T	getInstance()	Return the instance this mapper is bound to.
T	populate(ConfigurationNode source)	Populate the annotated fields in a pre-created object
void	serialize(ConfigurationNode target)	Serialize the data contained in annotated fields to the configuration node.

Methods inherited from class java.lang.Object

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

Constructor Details

BoundInstance

protected BoundInstance(T boundInstance)

Method Details

populate

public T populate(ConfigurationNode source) throws ObjectMappingException

Populate the annotated fields in a pre-created object

Parameters:

source - The source to get data from

Returns:

The object provided, for easier chaining

Throws:

ObjectMappingException - If an error occurs while populating data

serialize

public void serialize(ConfigurationNode target) throws ObjectMappingException

Serialize the data contained in annotated fields to the configuration node.

Parameters:

target - The target node to serialize to

Throws:

ObjectMappingException - if serialization was not possible due to some error.

getInstance

public T getInstance()

Return the instance this mapper is bound to.

Returns:

The active instance