persistent/com.fantamomo.persistent.container

Package-level declarations

Provides container interfaces for storing and managing persistent key-value data. Defines core interfaces for common operations like get, set, remove and contains.

Types

BufferedPersistentDataContainer

interface BufferedPersistentDataContainer : PersistentDataContainer

A PersistentDataContainer that supports buffering.

EventPersistentDataContainer

interface EventPersistentDataContainer : PersistentDataContainer

MutableBufferedPersistentDataContainer

interface MutableBufferedPersistentDataContainer : BufferedPersistentDataContainer, MutablePersistentDataContainer

A mutable version of BufferedPersistentDataContainer that allows for flushing and refreshing the data.

MutablePersistentDataContainer

interface MutablePersistentDataContainer : PersistentDataContainer, MutableSet<String>

A mutable persistent data container that allows for modification of the data.

PersistentDataContainer

interface PersistentDataContainer : Set<String>

A container for persistent data.

PersistentDataProvider

interface PersistentDataProvider : PersistentDataViewProvider

An interface extending PersistentDataViewProvider to provide a mutable persistent data container.

PersistentDataViewProvider

interface PersistentDataViewProvider

Represents a provider that offers an immutable view of persistent data.

Functions

buildPersistentDataContainer

@JvmName(name = "build")

inline fun buildPersistentDataContainer(action: MutablePersistentDataContainer.() -> Unit): PersistentDataContainer

Builds a new instance of PersistentDataContainer using the specified configuration action.

bulk

inline fun MutablePersistentDataContainer.bulk(replace: Boolean = true, removeEntries: Boolean = replace, action: MutablePersistentDataContainer.() -> Unit)

This methode is used to make a bulk operation on the MutablePersistentDataContainer.

copyTo

fun PersistentDataContainer.copyTo(receiver: MutablePersistentDataContainer, replace: Boolean = true)

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

getDirect

@InternalPersistentApi

fun PersistentDataContainer.getDirect(key: String): Any?

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

getNullable

fun PersistentDataContainer.getNullable(key: String, type: PersistentDataType<P, C>): C?

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

getOrDefault

fun PersistentDataContainer.getOrDefault(key: String, type: PersistentDataType<P, C>, default: C): C

fun 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.

getOrThrow

inline fun PersistentDataContainer.getOrThrow(key: String, type: PersistentDataType<P, C>): C

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

getWithDefault

fun , 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.

MutablePersistentDataContainer

@JvmName(name = "mutable")

fun MutablePersistentDataContainer(): MutablePersistentDataContainer

Creates and returns a new instance of a mutable persistent data container.

PersistentDataContainer

@JvmName(name = "immutable")

fun PersistentDataContainer(): PersistentDataContainer

Creates an immutable instance of a PersistentDataContainer.

@JvmOverloads

@JvmName(name = "fromInputStream")

fun PersistentDataContainer(input: InputStream, serializer: SerializerStrategy = SerializerStrategy): PersistentDataContainer

Creates a new instance of PersistentDataContainer by deserializing data from the provided input stream.

putAll

fun MutablePersistentDataContainer.putAll(type: PersistentDataType<P, C>, vararg entries: Pair<String, C>)

Adds multiple entries to this container using vararg pairs.

fun MutablePersistentDataContainer.putAll(map: Map<String, C>, type: PersistentDataType<P, C>)

Adds all entries from the provided map to this container.

putAllNullable

fun MutablePersistentDataContainer.putAllNullable(map: Map<String, C?>, type: PersistentDataType<P, C>)

Adds multiple nullable entries to this container.

remove

fun MutablePersistentDataContainer.remove(key: String, type: PersistentDataType<P, C>): Boolean

This methode removes the value of the specified key from the PersistentDataContainer.

setNullable

fun MutablePersistentDataContainer.setNullable(key: String, type: PersistentDataType<P, C>, value: C?)

This method is used to set the value of the specified key in the PersistentDataContainer.

toBuffered

fun MutablePersistentDataContainer.toBuffered(): MutableBufferedPersistentDataContainer

Converts this MutablePersistentDataContainer into a MutableBufferedPersistentDataContainer.

fun PersistentDataContainer.toBuffered(): BufferedPersistentDataContainer

Converts the current PersistentDataContainer to a buffered version.

toConcurrentContainer

fun MutablePersistentDataContainer.toConcurrentContainer(): ConcurrentPersistentDataContainer

Converts the current MutablePersistentDataContainer to a thread-safe implementation by wrapping it in a ConcurrentPersistentDataContainer.

toImmutable

fun PersistentDataContainer.toImmutable(): PersistentDataContainer

Converts the current PersistentDataContainer instance to an immutable implementation.

toMap

fun PersistentDataContainer.toMap(type: PersistentDataType<P, C>): Map<String, C>

Converts this container's contents to a Map.

toMutable

fun PersistentDataContainer.toMutable(): MutablePersistentDataContainer

Converts this PersistentDataContainer into a MutablePersistentDataContainer.

tryGet

inline fun 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.