com.bgsoftware.superiorskyblock.api.persistence

Interface PersistentDataContainer

public interface PersistentDataContainer

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String key) Get a metadata value matching the provided key.
<T> T	get(java.lang.String key, PersistentDataType<T> type) Get a metadata value matching the provided key and type.
java.lang.Object	getOrDefault(java.lang.String key, java.lang.Object def) Get a metadata value matching the provided key.
<T> T	getOrDefault(java.lang.String key, PersistentDataType<T> type, T def) Get a metadata value matching the provided key and type.
boolean	has(java.lang.String key) Check if the provided key has a matching metadata value.
<T> boolean	hasKeyOfType(java.lang.String key, PersistentDataType<T> type) Check if the provided key has a matching metadata value of the provided type.
boolean	isEmpty() Check whether the container is empty.
void	load(byte[] data) Load contents from the serialized data into the container.
<T> T	put(java.lang.String key, PersistentDataType<T> type, T value) Store a metadata value matching the provided key and type.
<T,R> R	put(java.lang.String key, PersistentDataType<T> type, T value, PersistentDataType<R> returnType) Store a metadata value matching the provided key and type.
java.lang.Object	remove(java.lang.String key) Remove a metadata value matching the provided key.
<T> T	removeKeyOfType(java.lang.String key, PersistentDataType<T> type) Remove a metadata value matching the provided key and type.
byte[]	serialize() Get the serialized contents of the container as a bytes array.
int	size() Get the size of the container.

Method Detail

has

boolean has(java.lang.String key)

Check if the provided key has a matching metadata value.

Parameters:

key - The key to check.

hasKeyOfType

<T> boolean hasKeyOfType(java.lang.String key,
                         PersistentDataType<T> type)

Check if the provided key has a matching metadata value of the provided type.

Parameters:

key - The key to check.

type - The type to check.

put

@Nullable
<T> T put(java.lang.String key,
                     PersistentDataType<T> type,
                     T value)
              throws org.apache.commons.lang.IllegalClassException,
                     java.lang.IllegalStateException

Store a metadata value matching the provided key and type.

Parameters:

key - The key to store.

type - The type of the metadata value.

value - The metadata value to store.

Returns:

The old metadata value that was stored matching the key, if exists.

Throws:

org.apache.commons.lang.IllegalClassException - If the old metadata value is not of type .

java.lang.IllegalStateException - If doesn't have a valid serializer available.

put

@Nullable
<T,R> R put(java.lang.String key,
                       PersistentDataType<T> type,
                       T value,
                       PersistentDataType<R> returnType)
                throws org.apache.commons.lang.IllegalClassException,
                       java.lang.IllegalStateException

Store a metadata value matching the provided key and type.

Parameters:

key - The key to store.

type - The type of the metadata.

value - The metadata value to store.

returnType - The type of the old metadata value.

Returns:

The old metadata value that was stored matching the key, if exists.

Throws:

org.apache.commons.lang.IllegalClassException - If the old metadata value is not of type .

java.lang.IllegalStateException - If doesn't have a valid serializer available.

remove

@Nullable
java.lang.Object remove(java.lang.String key)

Remove a metadata value matching the provided key.

Parameters:

key - The key to remove.

Returns:

The old metadata value that was stored matching the key, if exists.

removeKeyOfType

@Nullable
<T> T removeKeyOfType(java.lang.String key,
                                 PersistentDataType<T> type)

Remove a metadata value matching the provided key and type. If the metadata value doesn't match the , it will not get removed.

Parameters:

key - The key to remove.

type - The type of the metadata value to remove.

Returns:

The old metadata value that was stored matching the key, if exists. If the metadata value does not match the current type, null will be returned.

get

@Nullable
<T> T get(java.lang.String key,
                     PersistentDataType<T> type)
              throws org.apache.commons.lang.IllegalClassException

Get a metadata value matching the provided key and type.

Parameters:

key - The key to fetch.

type - The type of the metadata value to fetch.

Returns:

The metadata value that is stored matching the key, if exists.

Throws:

org.apache.commons.lang.IllegalClassException - If the metadata value is not of type .

get

@Nullable
java.lang.Object get(java.lang.String key)

Get a metadata value matching the provided key.

Parameters:

key - The key to fetch.

Returns:

The metadata value that is stored matching the key, if exists.

getOrDefault

<T> T getOrDefault(java.lang.String key,
                   PersistentDataType<T> type,
                   T def)
            throws org.apache.commons.lang.IllegalClassException

Get a metadata value matching the provided key and type.

Parameters:

key - The key to fetch.

type - The type of the metadata value to fetch.

def - Value to return in case there is no metadata value matching the provided key.

Returns:

The metadata value that is stored matching the key, or otherwise.

Throws:

org.apache.commons.lang.IllegalClassException - If the metadata value is not of type .

getOrDefault

java.lang.Object getOrDefault(java.lang.String key,
                              java.lang.Object def)

Get a metadata value matching the provided key.

Parameters:

key - The key to fetch.

def - Value to return in case there is no metadata value matching the provided key.

Returns:

The metadata value that is stored matching the key, or otherwise.

isEmpty

boolean isEmpty()

Check whether the container is empty.

size

int size()

Get the size of the container.

serialize

byte[] serialize()

Get the serialized contents of the container as a bytes array. The format of the serialized data may be different depending on the implementation of the container. The serialized data must be loaded without any errors using load(byte[]).

load

void load(byte[] data)
   throws java.lang.IllegalArgumentException

Load contents from the serialized data into the container. The format of the serialized data may be different depending on the implementation of the container.

Parameters:

data - The serialized data.

Throws:

java.lang.IllegalArgumentException - If the given data cannot be serialized correctly.