Package io.github.sefiraat.networks.utils.datatypes

Class DataTypeMethods

java.lang.Object

io.github.sefiraat.networks.utils.datatypes.DataTypeMethods

public class DataTypeMethods
extends Object

Constructor Summary

Constructors

Constructor	Description
DataTypeMethods()

Method Summary

Modifier and Type	Method	Description
static <T, Z> Z	getCustom(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	getCustom(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 <T, Z> Optional<Z>	getOptionalCustom(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 <T, Z> boolean	hasCustom(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type)	Checks if the specified PersistentDataHolder has a PersistentDataContainer with the specified key.
static <T, Z> void	setCustom(PersistentDataHolder holder, NamespacedKey key, PersistentDataType<T,Z> type, Z obj)	Set a custom PersistentDataType in a PersistentDataContainer

Methods inherited from class java.lang.Object

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

Constructor Details

DataTypeMethods

public DataTypeMethods()

Method Details

getCustom

@Nullable
public static <T,
Z> Z getCustom(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key,
 @Nonnull
 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

getOptionalCustom

@Nonnull
public static <T,
Z> Optional<Z> getOptionalCustom(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key,
 @Nonnull
 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:

• PersistentDataAPI#getCustom(PersistentDataHolder, NamespacedKey, PersistentDataType)

getCustom

public static <T,
Z> Z getCustom(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key,
 @Nonnull
 PersistentDataType<T,Z> type,
 @Nonnull
 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

hasCustom

public static <T,
Z> boolean hasCustom(@Nonnull
 PersistentDataHolder holder,
 @Nonnull
 NamespacedKey key,
 @Nonnull
 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.

setCustom

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

Set a custom 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