persistent/com.fantamomo.persistent.container.impl/BufferedPersistentDataContainerImpl

BufferedPersistentDataContainerImpl

open class BufferedPersistentDataContainerImpl(delegate: PersistentDataContainer) : BufferedPersistentDataContainer(source)

Implementation of BufferedPersistentDataContainer that provides support for buffered operations on a PersistentDataContainer.

This implementation uses a buffer to cache data operations temporarily before interacting with the underlying persistent storage via a delegate PersistentDataContainer. The buffer ensures that changes are stored until explicitly saved or cleared, reducing the need for repeated access to the underlying storage.

The buffer operates on key-value pairs, where the value can consist of primitive or complex data types. The conversion between these types is managed by PersistentDataType.

Author

Fantamomo

Since

1.0-SNAPSHOT

Parameters

delegate

The underlying PersistentDataContainer that this implementation delegates operations to when necessary.

The following methods are supported:

Data retrieval and storage using buffered entries with automatic type handling, realized through get, contains, and getPrimitive.
Management of buffered entries, such as clearing or deleting specific entries, with clearBuffer and deleteBuffer.
Data persistence through the delegate's ability to save to an output stream.

Inheritors

MutableBufferedPersistentDataContainerImpl

Constructors

BufferedPersistentDataContainerImpl

constructor(delegate: PersistentDataContainer)

Creates a new instance with a specified delegate PersistentDataContainer.

Properties

size

open override val size: Int

Functions

bound

@JvmName(name = "create")

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

clearBuffer

open override fun clearBuffer()

Clears the buffer.

contains

open operator override fun contains(element: String): Boolean

open override fun contains(key: String, type: PersistentDataType<P, C>): Boolean

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

contains

operator fun PersistentDataContainer.contains(key: PersistentKey<P, C>): Boolean

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

containsAll

open override fun containsAll(elements: Collection<String>): Boolean

copyTo

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

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

deleteBuffer

open override fun deleteBuffer(key: String)

Deletes the buffer with the given key.

equals

open operator override fun equals(other: Any?): Boolean

get

open operator override fun get(key: String, type: PersistentDataType<P, C>): C?

Gets the value associated with the specified key.

get

operator fun PersistentDataContainer.get(key: PersistentKey<P, C>): C?

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

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.

getPrimitive

open override fun getPrimitive(key: String, type: PersistentDataType<P, C>): P?

Gets the primitive value associated with the specified 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.

hashCode

open override fun hashCode(): Int

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): Iterator<String>

saveTo

open override fun saveTo(output: OutputStream, serializer: SerializerStrategy)

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

toBuffered

fun PersistentDataContainer.toBuffered(): BufferedPersistentDataContainer

Converts the current PersistentDataContainer to a buffered version.

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.