Package io.github.bakedlibs.dough.data.persistent

Class PersistentDataAPI

java.lang.Object

io.github.bakedlibs.dough.data.persistent.PersistentDataAPI

@ParametersAreNonnullByDefault
public final class PersistentDataAPI
extends Object

This is a utility class that allows you to modify data for any Objects that implement PersistentDataHolder.

Author:

Walshy, TheBusyBiscuit

Method Summary

Modifier and Type	Method	Description
static <T, Z> Z	get(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type)	Get an object based on the provided PersistentDataType in a PersistentDataContainer, if the key doesn't exist it returns null.
static <T, Z> Z	get(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type, Z defaultVal)	Get an object based on the provided PersistentDataType in a PersistentDataContainer or the default value if the key doesn't exist.
static boolean	getBoolean(PersistentDataHolder holder, NamespacedKey key)	Get a byte value in a PersistentDataContainer or the default value passed if no key exists.
static byte	getByte(PersistentDataHolder holder, NamespacedKey key)	Get a byte value in a PersistentDataContainer, if the key doesn't exist it returns -1.
static byte	getByte(PersistentDataHolder holder, NamespacedKey key, byte defaultVal)	Get a byte value in a PersistentDataContainer or the default value passed if no key exists.
static byte[]	getByteArray(PersistentDataHolder holder, NamespacedKey key)	Get a byte array in a PersistentDataContainer, if the key doesn't exist it returns null.
static byte[]	getByteArray(PersistentDataHolder holder, NamespacedKey key, byte... defaultVal)	Get a byte array in a PersistentDataContainer or the default value passed if no key exists.
static PersistentDataContainer	getContainer(PersistentDataHolder holder, NamespacedKey key)	Get a nested PersistentDataContainer, if the key doesn't exist it returns null.
static PersistentDataContainer	getContainer(PersistentDataHolder holder, NamespacedKey key, PersistentDataContainer defaultVal)	Get a nested PersistentDataContainer or the default value passed if no key exists.
static double	getDouble(PersistentDataHolder holder, NamespacedKey key)	Get a double value in a PersistentDataContainer, if the key doesn't exist it returns -1.
static double	getDouble(PersistentDataHolder holder, NamespacedKey key, double defaultVal)	Get a double value in a PersistentDataContainer or the default value passed if no key exists.
static float	getFloat(PersistentDataHolder holder, NamespacedKey key)	Get a float value in a PersistentDataContainer, if the key doesn't exist it returns -1.
static float	getFloat(PersistentDataHolder holder, NamespacedKey key, float defaultVal)	Get a float value in a PersistentDataContainer or the default value passed if no key exists.
static int	getInt(PersistentDataHolder holder, NamespacedKey key)	Get an integer value in a PersistentDataContainer, if the key doesn't exist it returns -1.
static int	getInt(PersistentDataHolder holder, NamespacedKey key, int defaultVal)	Get an integer value in a PersistentDataContainer or the default value passed if no key exists.
static int[]	getIntArray(PersistentDataHolder holder, NamespacedKey key)	Get a integer array in a PersistentDataContainer, if the key doesn't exist it returns null.
static int[]	getIntArray(PersistentDataHolder holder, NamespacedKey key, int... defaultVal)	Get a byte array in a PersistentDataContainer or the default value passed if no key exists.
static com.google.gson.JsonArray	getJsonArray(PersistentDataHolder holder, NamespacedKey key)	Get a JsonArray in a PersistentDataContainer, if the key doesn't exist it returns null.
static com.google.gson.JsonArray	getJsonArray(PersistentDataHolder holder, NamespacedKey key, com.google.gson.JsonArray defaultVal)	Get a JsonArray in a PersistentDataContainer or the default value passed if no key exists.
static com.google.gson.JsonObject	getJsonObject(PersistentDataHolder holder, NamespacedKey key)	Get a JsonObject in a PersistentDataContainer, if the key doesn't exist it returns null.
static com.google.gson.JsonObject	getJsonObject(PersistentDataHolder holder, NamespacedKey key, com.google.gson.JsonObject defaultVal)	Get a JsonObject in a PersistentDataContainer or the default value passed if no key exists.
static long	getLong(PersistentDataHolder holder, NamespacedKey key)	Get a long value in a PersistentDataContainer, if the key doesn't exist it returns -1.
static long	getLong(PersistentDataHolder holder, NamespacedKey key, long defaultVal)	Get a long value in a PersistentDataContainer or the default value passed if no key exists.
static long[]	getLongArray(PersistentDataHolder holder, NamespacedKey key)	Get a long array in a PersistentDataContainer, if the key doesn't exist it returns null.
static long[]	getLongArray(PersistentDataHolder holder, NamespacedKey key, long... defaultVal)	Get a long array in a PersistentDataContainer or the default value passed if no key exists.
static <T, Z> Optional<Z>	getOptional(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type)	This method returns an Optional describing the object defined by the PersistentDataType found under the given key.
static Optional<Boolean>	getOptionalBoolean(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Byte found under the given key.
static Optional<Byte>	getOptionalByte(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Byte found under the given key.
static Optional<byte[]>	getOptionalByteArray(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Byte Array found under the given key.
static Optional<PersistentDataContainer>	getOptionalContainer(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the PersistentDataContainer found under the given key.
static OptionalDouble	getOptionalDouble(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Double found under the given key.
static Optional<Float>	getOptionalFloat(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Float found under the given key.
static OptionalInt	getOptionalInt(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Integer found under the given key.
static Optional<int[]>	getOptionalIntArray(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Integer Array found under the given key.
static Optional<com.google.gson.JsonArray>	getOptionalJsonArray(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the JsonArray found under the given key.
static Optional<com.google.gson.JsonObject>	getOptionalJsonObject(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the JsonObject found under the given key.
static OptionalLong	getOptionalLong(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Long found under the given key.
static Optional<long[]>	getOptionalLongArray(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Long Array found under the given key.
static Optional<Short>	getOptionalShort(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the Short found under the given key.
static Optional<String>	getOptionalString(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the String found under the given key.
static Optional<UUID>	getOptionalUUID(PersistentDataHolder holder, NamespacedKey key)	This method returns an Optional describing the UUID found under the given key.
static short	getShort(PersistentDataHolder holder, NamespacedKey key)	Get a short value in a PersistentDataContainer, if the key doesn't exist it returns -1.
static short	getShort(PersistentDataHolder holder, NamespacedKey key, short defaultVal)	Get a short value in a PersistentDataContainer or the default value passed if no key exists.
static String	getString(PersistentDataHolder holder, NamespacedKey key)	Get a String value in a PersistentDataContainer, if the key doesn't exist it returns null.
static String	getString(PersistentDataHolder holder, NamespacedKey key, String defaultVal)	Get a String value in a PersistentDataContainer or the default value passed if no key exists.
static UUID	getUUID(PersistentDataHolder holder, NamespacedKey key)	Get a UUID in a PersistentDataContainer, if the key doesn't exist it returns null.
static <T, Z> boolean	has(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static boolean	hasBoolean(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static boolean	hasByte(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a byte with the specified key.
static boolean	hasByteArray(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a byte array with the specified key.
static boolean	hasContainer(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static boolean	hasDouble(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a double with the specified key.
static boolean	hasFloat(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a float with the specified key.
static boolean	hasInt(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has an integer with the specified key.
static boolean	hasIntArray(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has an integer array with the specified key.
static boolean	hasJsonArray(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static boolean	hasJsonObject(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static boolean	hasLong(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a long with the specified key.
static boolean	hasLongArray(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a long array with the specified key.
static boolean	hasShort(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a short with the specified key.
static boolean	hasString(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a String with the specified key.
static boolean	hasUUID(PersistentDataHolder holder, NamespacedKey key)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static void	remove(PersistentDataHolder holder, NamespacedKey key)	This removes the data stored with the given key on the given data holder
static <T, Z> void	set(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type, Z obj)	Set a custom object based on the given PersistentDataType in a PersistentDataContainer
static void	setBoolean(PersistentDataHolder holder, NamespacedKey key, boolean value)
static void	setByte(PersistentDataHolder holder, NamespacedKey key, byte value)
static void	setByteArray(PersistentDataHolder holder, NamespacedKey key, byte... value)
static void	setContainer(PersistentDataHolder holder, NamespacedKey key, PersistentDataContainer value)
static void	setDouble(PersistentDataHolder holder, NamespacedKey key, double value)
static void	setFloat(PersistentDataHolder holder, NamespacedKey key, float value)
static void	setInt(PersistentDataHolder holder, NamespacedKey key, int value)
static void	setIntArray(PersistentDataHolder holder, NamespacedKey key, int... value)
static void	setJsonArray(PersistentDataHolder holder, NamespacedKey key, com.google.gson.JsonArray value)
static void	setJsonObject(PersistentDataHolder holder, NamespacedKey key, com.google.gson.JsonObject value)
static void	setLong(PersistentDataHolder holder, NamespacedKey key, long value)
static void	setLongArray(PersistentDataHolder holder, NamespacedKey key, long... value)
static void	setShort(PersistentDataHolder holder, NamespacedKey key, short value)
static void	setString(PersistentDataHolder holder, NamespacedKey key, String value)
static void	setUUID(PersistentDataHolder holder, NamespacedKey key, UUID uuid)	Set a UUID in a PersistentDataContainer, split as the 2 longs containing its bits.

Methods inherited from class java.lang.Object

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

Method Details

setByte

public static void setByte(PersistentDataHolder holder,
 NamespacedKey key,
 byte value)

setShort

public static void setShort(PersistentDataHolder holder,
 NamespacedKey key,
 short value)

setInt

public static void setInt(PersistentDataHolder holder,
 NamespacedKey key,
 int value)

setLong

public static void setLong(PersistentDataHolder holder,
 NamespacedKey key,
 long value)

setFloat

public static void setFloat(PersistentDataHolder holder,
 NamespacedKey key,
 float value)

setDouble

public static void setDouble(PersistentDataHolder holder,
 NamespacedKey key,
 double value)

setString

public static void setString(PersistentDataHolder holder,
 NamespacedKey key,
 String value)

setByteArray

public static void setByteArray(PersistentDataHolder holder,
 NamespacedKey key,
 byte... value)

setIntArray

public static void setIntArray(PersistentDataHolder holder,
 NamespacedKey key,
 int... value)

setLongArray

public static void setLongArray(PersistentDataHolder holder,
 NamespacedKey key,
 long... value)

setContainer

public static void setContainer(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataContainer value)

setBoolean

public static void setBoolean(PersistentDataHolder holder,
 NamespacedKey key,
 boolean value)

setJsonObject

public static void setJsonObject(PersistentDataHolder holder,
 NamespacedKey key,
 com.google.gson.JsonObject value)

setJsonArray

public static void setJsonArray(PersistentDataHolder holder,
 NamespacedKey key,
 com.google.gson.JsonArray value)

setUUID

public static void setUUID(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key,
 @Nonnull
 UUID uuid)

Set a UUID in a PersistentDataContainer, split as the 2 longs containing its bits.

Parameters:

holder - The PersistentDataHolder to add the data to

key - The key of the data to set

uuid - The uuid to put in the container

set

@ParametersAreNonnullByDefault
public static <T,
Z> void set(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataType<T,Z> type,
 Z obj)

Set a custom object based on the given PersistentDataType in a PersistentDataContainer

Parameters:

holder - The PersistentDataHolder to add the data to

key - The key of the data to set

type - The PersistentDataType to be used.

obj - The object to put in the container

hasByte

public static boolean hasByte(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a byte with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a byte with the specified key.

hasShort

public static boolean hasShort(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a short with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a short with the specified key.

hasInt

public static boolean hasInt(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has an integer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has an integer with the specified key.

hasLong

public static boolean hasLong(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a long with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a long with the specified key.

hasFloat

public static boolean hasFloat(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a float with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a float with the specified key.

hasDouble

public static boolean hasDouble(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a double with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a double with the specified key.

hasString

public static boolean hasString(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a String with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a String with the specified key.

hasByteArray

public static boolean hasByteArray(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a byte array with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a byte array with the specified key.

hasIntArray

public static boolean hasIntArray(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has an integer array with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has an integer array with the specified key.

hasLongArray

public static boolean hasLongArray(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a long array with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a long array with the specified key.

hasContainer

public static boolean hasContainer(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a PersistentDataContainer with the specified key.

hasBoolean

public static boolean hasBoolean(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a PersistentDataContainer with the specified key.

hasJsonObject

public static boolean hasJsonObject(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a PersistentDataContainer with the specified key.

hasJsonArray

public static boolean hasJsonArray(PersistentDataHolder holder,
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a PersistentDataContainer with the specified key.

hasUUID

public static boolean hasUUID(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key)

Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a PersistentDataContainer with the specified key.

has

@ParametersAreNonnullByDefault
public static <T,
Z> boolean has(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataType<T,Z> type)

Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.

Parameters:

holder - The PersistentDataHolder to check

key - The key to check for

Returns:

true if the holder has a PersistentDataContainer with the specified key.

getByte

public static byte getByte(PersistentDataHolder holder,
 NamespacedKey key)

Get a byte value in a PersistentDataContainer, if the key doesn't exist it returns -1.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The byte associated with this key or -1 if it doesn't exist

getOptionalByte

public static Optional<Byte> getOptionalByte(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Byte found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getByte(PersistentDataHolder, NamespacedKey)

getByte

public static byte getByte(PersistentDataHolder holder,
 NamespacedKey key,
 byte defaultVal)

Get a byte value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The byte associated with this key or the default value if it doesn't exist

getOptionalBoolean

public static Optional<Boolean> getOptionalBoolean(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Byte found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getByte(PersistentDataHolder, NamespacedKey)

getBoolean

public static boolean getBoolean(PersistentDataHolder holder,
 NamespacedKey key)

Get a byte value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The byte associated with this key or the default value if it doesn't exist

getShort

public static short getShort(PersistentDataHolder holder,
 NamespacedKey key)

Get a short value in a PersistentDataContainer, if the key doesn't exist it returns -1.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The short associated with this key or -1 if it doesn't exist

getOptionalShort

public static Optional<Short> getOptionalShort(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Short found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getShort(PersistentDataHolder, NamespacedKey)

getShort

public static short getShort(PersistentDataHolder holder,
 NamespacedKey key,
 short defaultVal)

Get a short value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The short associated with this key or the default value if it doesn't exist

getInt

public static int getInt(PersistentDataHolder holder,
 NamespacedKey key)

Get an integer value in a PersistentDataContainer, if the key doesn't exist it returns -1.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The integer associated with this key or -1 if it doesn't exist

getOptionalInt

public static OptionalInt getOptionalInt(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Integer found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getInt(PersistentDataHolder, NamespacedKey)

getInt

public static int getInt(PersistentDataHolder holder,
 NamespacedKey key,
 int defaultVal)

Get an integer value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The integer associated with this key or the default value if it doesn't exist

getLong

public static long getLong(PersistentDataHolder holder,
 NamespacedKey key)

Get a long value in a PersistentDataContainer, if the key doesn't exist it returns -1.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The long associated with this key or -1 if it doesn't exist

getOptionalLong

public static OptionalLong getOptionalLong(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Long found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getLong(PersistentDataHolder, NamespacedKey)

getLong

public static long getLong(PersistentDataHolder holder,
 NamespacedKey key,
 long defaultVal)

Get a long value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The long associated with this key or the default value if it doesn't exist

getFloat

public static float getFloat(PersistentDataHolder holder,
 NamespacedKey key)

Get a float value in a PersistentDataContainer, if the key doesn't exist it returns -1.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The float associated with this key or -1 if it doesn't exist

getOptionalFloat

public static Optional<Float> getOptionalFloat(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Float found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getFloat(PersistentDataHolder, NamespacedKey)

getFloat

public static float getFloat(PersistentDataHolder holder,
 NamespacedKey key,
 float defaultVal)

Get a float value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The float associated with this key or the default value if it doesn't exist

getDouble

public static double getDouble(PersistentDataHolder holder,
 NamespacedKey key)

Get a double value in a PersistentDataContainer, if the key doesn't exist it returns -1.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The double associated with this key or -1 if it doesn't exist

getOptionalDouble

public static OptionalDouble getOptionalDouble(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Double found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getDouble(PersistentDataHolder, NamespacedKey)

getDouble

public static double getDouble(PersistentDataHolder holder,
 NamespacedKey key,
 double defaultVal)

Get a double value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The double associated with this key or the default value if it doesn't exist

getString

public static String getString(PersistentDataHolder holder,
 NamespacedKey key)

Get a String value in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The String associated with this key or null if it doesn't exist

getOptionalString

public static Optional<String> getOptionalString(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the String found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getString(PersistentDataHolder, NamespacedKey)

getString

public static String getString(PersistentDataHolder holder,
 NamespacedKey key,
 String defaultVal)

Get a String value in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The String associated with this key or the default value if it doesn't exist

getByteArray

public static byte[] getByteArray(PersistentDataHolder holder,
 NamespacedKey key)

Get a byte array in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The byte array associated with this key or null if it doesn't exist

getOptionalByteArray

public static Optional<byte[]> getOptionalByteArray(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Byte Array found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getByteArray(PersistentDataHolder, NamespacedKey)

getByteArray

public static byte[] getByteArray(PersistentDataHolder holder,
 NamespacedKey key,
 byte... defaultVal)

Get a byte array in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The byte array associated with this key or the default value if it doesn't exist

getIntArray

public static int[] getIntArray(PersistentDataHolder holder,
 NamespacedKey key)

Get a integer array in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The integer array associated with this key or null if it doesn't exist

getOptionalIntArray

public static Optional<int[]> getOptionalIntArray(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Integer Array found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getIntArray(PersistentDataHolder, NamespacedKey)

getIntArray

public static int[] getIntArray(PersistentDataHolder holder,
 NamespacedKey key,
 int... defaultVal)

Get a byte array in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The byte associated with this key or the default value if it doesn't exist

getLongArray

public static long[] getLongArray(PersistentDataHolder holder,
 NamespacedKey key)

Get a long array in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The long array associated with this key or null if it doesn't exist

getOptionalLongArray

public static Optional<long[]> getOptionalLongArray(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the Long Array found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getLongArray(PersistentDataHolder, NamespacedKey)

getLongArray

public static long[] getLongArray(PersistentDataHolder holder,
 NamespacedKey key,
 long... defaultVal)

Get a long array in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The long array associated with this key or the default value if it doesn't exist

getContainer

public static PersistentDataContainer getContainer(PersistentDataHolder holder,
 NamespacedKey key)

Get a nested PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The byte associated with this key or null if it doesn't exist

getOptionalContainer

public static Optional<PersistentDataContainer> getOptionalContainer(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the PersistentDataContainer found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getContainer(PersistentDataHolder, NamespacedKey)

getContainer

public static PersistentDataContainer getContainer(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataContainer defaultVal)

Get a nested PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The byte associated with this key or the default value if it doesn't exist

getJsonObject

public static com.google.gson.JsonObject getJsonObject(PersistentDataHolder holder,
 NamespacedKey key)

Get a JsonObject in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The long array associated with this key or null if it doesn't exist

getOptionalJsonObject

public static Optional<com.google.gson.JsonObject> getOptionalJsonObject(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the JsonObject found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getJsonObject(PersistentDataHolder, NamespacedKey)

getJsonObject

public static com.google.gson.JsonObject getJsonObject(PersistentDataHolder holder,
 NamespacedKey key,
 com.google.gson.JsonObject defaultVal)

Get a JsonObject in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The long array associated with this key or the default value if it doesn't exist

getJsonArray

public static com.google.gson.JsonArray getJsonArray(PersistentDataHolder holder,
 NamespacedKey key)

Get a JsonArray in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The long array associated with this key or null if it doesn't exist

getOptionalJsonArray

public static Optional<com.google.gson.JsonArray> getOptionalJsonArray(PersistentDataHolder holder,
 NamespacedKey key)

This method returns an Optional describing the JsonArray found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getJsonObject(PersistentDataHolder, NamespacedKey)

getJsonArray

public static com.google.gson.JsonArray getJsonArray(PersistentDataHolder holder,
 NamespacedKey key,
 com.google.gson.JsonArray defaultVal)

Get a JsonArray in a PersistentDataContainer or the default value passed if no key exists.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The long array associated with this key or the default value if it doesn't exist

getUUID

@Nullable
public static UUID getUUID(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key)

Get a UUID in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

The UUID associated with this key or null if it doesn't exist

getOptionalUUID

@Nonnull
public static Optional<UUID> getOptionalUUID(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key)

This method returns an Optional describing the UUID found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• getUUID(PersistentDataHolder, NamespacedKey)

get

@Nullable
@ParametersAreNonnullByDefault
public static <T,
Z> Z get(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataType<T,Z> type)

Get an object based on the provided PersistentDataType in a PersistentDataContainer, if the key doesn't exist it returns null.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An object associated with this key or null if it doesn't exist

get

@Nonnull
@ParametersAreNonnullByDefault
public static <T,
Z> Z get(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataType<T,Z> type,
 Z defaultVal)

Get an object based on the provided PersistentDataType in a PersistentDataContainer or the default value if the key doesn't exist.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

defaultVal - The default value to use if no key is found

Returns:

The object associated with this key or the default value if it doesn't exist

remove

public static void remove(PersistentDataHolder holder,
 NamespacedKey key)

This removes the data stored with the given key on the given data holder

Parameters:

holder - The PersistentDataHolder to remove the data from

key - The key of the data to remove

getOptional

@Nonnull
@ParametersAreNonnullByDefault
public static <T,
Z> Optional<Z> getOptional(PersistentDataHolder holder,
 NamespacedKey key,
 PersistentDataType<T,Z> type)

This method returns an Optional describing the object defined by the PersistentDataType found under the given key. An empty Optional will be returned if no value has been found.

Parameters:

holder - The PersistentDataHolder to retrieve the data from

key - The key of the data to retrieve

Returns:

An Optional describing the result

See Also:

• get(PersistentDataHolder, NamespacedKey, PersistentDataType)