persistent/com.fantamomo.persistent.container/PersistentDataContainer

PersistentDataContainer

interface PersistentDataContainer : Set<String> (source)

A container for persistent data.

This interface extends Set to provide a collection of keys, and provides methods to get and check the existence of data associated with those keys.

The data is stored in a key-value format, where the key is a String and the value can be of any type.

The data can be of a primitive type or a complex type, and the conversion between these types is handled by the PersistentDataType.

The container also provides a method to save the data to an output stream using a specified serializer strategy.

Author

Fantamomo

Since

1.0-SNAPSHOT

See also

Inheritors

Properties

Link copied to clipboard
abstract override val size: Int

Functions

Link copied to clipboard
@JvmName(name = "create")
fun <P : Any, C : Any> PersistentDataContainer.bound(key: String, type: PersistentDataType<P, C>): BoundEntry<P, C>

Creates a bound entry for accessing persistent data within the container.

@JvmName(name = "create")
fun <P : Any, C : Any> PersistentDataContainer.bound(key: String, type: PersistentDataType<P, C>, default: () -> C): DefaultBoundEntry<P, C>

Creates a DefaultBoundEntry that is bound to the specified PersistentDataContainer. This entry allows the retrieval of a value using the specified key and type, with the capability to provide a default value if the key does not exist in the container.

Link copied to clipboard
abstract fun <P : Any, C : Any> contains(key: String, type: PersistentDataType<P, C>): Boolean

Checks if the container contains a value associated with the specified key.

abstract operator override fun contains(element: String): Boolean
Link copied to clipboard
operator fun <P : Any, C : Any> PersistentDataContainer.contains(key: PersistentKey<P, C>): Boolean

Checks if the container contains a value associated with the specified PersistentKey.

Link copied to clipboard
abstract override fun containsAll(elements: Collection<String>): Boolean
Link copied to clipboard
fun PersistentDataContainer.copyTo(receiver: MutablePersistentDataContainer, replace: Boolean = true)

This methode copies all key-value pairs from the PersistentDataContainer to the receiver.

Link copied to clipboard
abstract operator fun <P : Any, C : Any> get(key: String, type: PersistentDataType<P, C>): C?

Gets the value associated with the specified key.

Link copied to clipboard
operator fun <P : Any, C : Any> PersistentDataContainer.get(key: PersistentKey<P, C>): C?

Retrieves the value associated with the specified key from the persistent data container.

Link copied to clipboard
@InternalPersistentApi
fun PersistentDataContainer.getDirect(key: String): Any?

This methode is used to get the direct value of the key.

Link copied to clipboard
fun <P : Any, C : Any> PersistentDataContainer.getNullable(key: String, type: PersistentDataType<P, C>): C?

This method is used to get the value of the specified key from the PersistentDataContainer.

Link copied to clipboard
fun <P : Any, C : Any> PersistentDataContainer.getOrDefault(key: String, type: PersistentDataType<P, C>, default: C): C
fun <P : Any, C : Any> PersistentDataContainer.getOrDefault(key: String, type: PersistentDataType<P, C>, default: () -> C): C

This method is used to get the value of the specified key from the PersistentDataContainer.

Link copied to clipboard
inline fun <P : Any, C : Any> PersistentDataContainer.getOrThrow(key: String, type: PersistentDataType<P, C>): C

This methode is uses to get the element by the key.

Link copied to clipboard
abstract fun <P : Any, C : Any> getPrimitive(key: String, type: PersistentDataType<P, C>): P?

Gets the primitive value associated with the specified key.

Link copied to clipboard
fun <P : Any, C : Any, T : PersistentDataType<P, C>, DefaultPersistentDataType<C>> PersistentDataContainer.getWithDefault(key: String, type: T, default: C = type.defaultValue): C

This method is used to get the value of the specified key from the PersistentDataContainer.

Link copied to clipboard
abstract override fun isEmpty(): Boolean
Link copied to clipboard
abstract operator override fun iterator(): Iterator<String>
Link copied to clipboard
abstract fun saveTo(output: OutputStream, serializer: SerializerStrategy = SerializerStrategy)

Saves the data in the container to the specified output stream.

Link copied to clipboard
Link copied to clipboard
fun PersistentDataContainer.toImmutable(): PersistentDataContainer

Converts the current PersistentDataContainer instance to an immutable implementation.

Link copied to clipboard
fun <P : Any, C : Any> PersistentDataContainer.toMap(type: PersistentDataType<P, C>): Map<String, C>

Converts this container's contents to a Map.

Link copied to clipboard
Link copied to clipboard
inline fun <P : Any, C : Any> PersistentDataContainer.tryGet(key: String, type: PersistentDataType<P, C>): Result<C>

Attempts to retrieve a value from the persistent data container associated with the specified key and type, returning the result wrapped in a Result type.