net.citizensnpcs.api.persistence

Annotation Type Persist

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Persist

Tells the PersistenceLoader to persist this field by saving and loading it into DataKeys.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	collectionType The specialised collection type to use when a super class is specified.
String	namespace If using global/static persistence, must be non-empty.
boolean	reify Whether to use PersistenceLoader to load/save the value of this class.
boolean	required Whether a value must be present at load time.
String	value The save key to use when saving.
Class<?>	valueType The specific value type to use when deserialising values from storage.

Element Detail

collectionType

public abstract Class<?> collectionType

The specialised collection type to use when a super class is specified. Eg. WeakHashMap.class when the field type is Map.

Default:

java.util.Collection.class

namespace

public abstract String namespace

If using global/static persistence, must be non-empty.

Default:

""

reify

public abstract boolean reify

Whether to use PersistenceLoader to load/save the value of this class.

Default:

false

required

public abstract boolean required

Whether a value must be present at load time. If a value for the field could not be loaded, PersistenceLoader.load(Object, DataKey) will return null.

Default:

false

value

public abstract String value

The save key to use when saving. If not present, the field name will be used instead.

• @Persist -> root key + field name
• @Persist("") -> root key + "" (or simply root key)
• @Persist("sub") root key + "sub"

Default:

"UNINITIALISED"

valueType

public abstract Class<?> valueType

The specific value type to use when deserialising values from storage. Most useful when using specific number types e.g. Long, Byte, Short but storing as Integer.

Default:

java.lang.Object.class