net.citizensnpcs.api.persistence

Class PersistenceLoader

java.lang.Object

net.citizensnpcs.api.persistence.PersistenceLoader

public class PersistenceLoader
extends Object

The main registry for managing reflective, recursive NPC persistence.

See Also:

Persist, registerPersistDelegate(Class, Class)

Constructor Summary

Constructors

Constructor and Description
PersistenceLoader()

Method Summary

Modifier and Type	Method and Description
static <T> T	load(Class<? extends T> clazz, DataKey root) Creates an instance of the given class using the default constructor and loads it using load(Object, DataKey).
static <T> T	load(T instance, DataKey root) Analyses the class for Fields with the Persist annotation and loads data into them using the given DataKey.
static void	registerPersistDelegate(Class<?> clazz, Class<? extends Persister<?>> delegateClass) Registers a Persister redirect.
static void	save(Object instance, DataKey root) Scans the object for fields annotated with Persist and saves them to the given DataKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistenceLoader

public PersistenceLoader()

Method Detail

load

public static <T> T load(Class<? extends T> clazz,
                         DataKey root)

Creates an instance of the given class using the default constructor and loads it using load(Object, DataKey). Will return null if an exception occurs.

Parameters:

clazz - The class to create an instance from

root - The root key to load from

Returns:

The loaded instance

See Also:

load(Object, DataKey)

load

public static <T> T load(T instance,
                         DataKey root)

Analyses the class for Fields with the Persist annotation and loads data into them using the given DataKey. If a DelegatePersistence annotation is provided the referenced Persister will be used to create the instance. This annotation can be omitted if the Persister has been registered using registerPersistDelegate(Class, Class)

Parameters:

instance - The instance to load data into

root - The key to load data from

Returns:

The instance, with persisted fields loaded

registerPersistDelegate

public static void registerPersistDelegate(Class<?> clazz,
                                           Class<? extends Persister<?>> delegateClass)

Registers a Persister redirect. Fields with the Persist annotation with a type that has been registered using this method will use the Persister by default to load and save data. The DelegatePersistence annotation will be preferred if present.

Parameters:

clazz - The class to redirect

delegateClass - The Persister class to use when loading and saving

save

public static void save(Object instance,
                        DataKey root)

Scans the object for fields annotated with Persist and saves them to the given DataKey.

Parameters:

instance - The instance to save

root - The key to save into