Package org.bukkit.persistence

Interface PersistentDataContainer

All Superinterfaces:

PersistentDataContainerView

public interface PersistentDataContainer
extends PersistentDataContainerView

This interface represents a map like object, capable of storing custom tags in it.

Method Summary

Modifier and Type	Method	Description
default void	readFromBytes(byte @NotNull [] bytes)	Read values from a serialised byte array into this PersistentDataContainer instance.
void	readFromBytes(byte @NotNull [] bytes, boolean clear)	Read values from a serialised byte array into this PersistentDataContainer instance.
void	remove(@NotNull NamespacedKey key)	Removes a custom key from the PersistentDataHolder instance.
<P, C> void	set(@NotNull NamespacedKey key, @NotNull PersistentDataType<P,C> type, C value)	Stores a metadata value on the PersistentDataHolder instance.

Methods inherited from interface io.papermc.paper.persistence.PersistentDataContainerView

copyTo, get, getAdapterContext, getKeys, getOrDefault, has, has, isEmpty, serializeToBytes

Method Details

set

<P,
C> void set(@NotNull
 @NotNull NamespacedKey key,
 @NotNull
 @NotNull PersistentDataType<P,C> type,
 @NotNull
 C value)

Stores a metadata value on the PersistentDataHolder instance.

This API cannot be used to manipulate minecraft data, as the values will be stored using your namespace. This method will override any existing value the PersistentDataHolder may have stored under the provided key.

Type Parameters:

P - the generic java type of the tag value

C - the generic type of the object to store

Parameters:

key - the key this value will be stored under

type - the type this tag uses

value - the value to store in the tag

Throws:

IllegalArgumentException - if the key is null

IllegalArgumentException - if the type is null

IllegalArgumentException - if the value is null. Removing a tag should be done using remove(NamespacedKey)

IllegalArgumentException - if no suitable adapter was found for the PersistentDataType.getPrimitiveType()

remove

void remove(@NotNull
 @NotNull NamespacedKey key)

Removes a custom key from the PersistentDataHolder instance.

Parameters:

key - the key to remove

Throws:

IllegalArgumentException - if the provided key is null

readFromBytes

void readFromBytes(byte @NotNull [] bytes,
 boolean clear)
            throws IOException

Read values from a serialised byte array into this PersistentDataContainer instance.

Parameters:

bytes - the byte array to read from

clear - if true, this PersistentDataContainer instance will be cleared before reading

Throws:

IOException - if the byte array has an invalid format

readFromBytes

default void readFromBytes(byte @NotNull [] bytes)
                    throws IOException

Read values from a serialised byte array into this PersistentDataContainer instance. This method has the same effect as PersistentDataContainer#readFromBytes(bytes, true)

Parameters:

bytes - the byte array to read from

Throws:

IOException - if the byte array has an invalid format