persistent/com.fantamomo.persistent.container.impl/PersistentDataContainerBuilder

PersistentDataContainerBuilder

class PersistentDataContainerBuilder : MutablePersistentDataContainerImpl(source)

A builder class for creating immutable instances of PersistentDataContainer.

This class extends MutablePersistentDataContainerImpl, allowing modifications to the persistent data during the build process. Once the build process is complete, the build function can be used to obtain an immutable PersistentDataContainer instance containing the configured data.

The builder allows you to leverage the mutable functionality provided by MutablePersistentDataContainerImpl and finalize the configuration into a read-only container.

Author

Fantamomo

Since

1.0-SNAPSHOT

Constructors

PersistentDataContainerBuilder

constructor()

Properties

size

open override val size: Int

Functions

add

open override fun add(element: String): Boolean

addAll

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

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.

build

fun build(): PersistentDataContainer

Finalizes the configuration of the persistent data and creates an immutable PersistentDataContainer instance.

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.

clear

open override fun clear()

Clears all values from this container.

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.

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(): MutableIterator<String>

loadFrom

open override fun loadFrom(input: InputStream, serializer: SerializerStrategy)

Loads data from the specified input stream using the specified serializer strategy.

mutableBound

@JvmName(name = "createMutable")

fun MutablePersistentDataContainer.mutableBound(key: String, type: PersistentDataType<P, C>): MutableBoundEntry<P, C>

Creates a new instance of MutableBoundEntry that is bound to the specified MutablePersistentDataContainer, using the provided key and PersistentDataType.

@JvmName(name = "createMutable")

fun MutablePersistentDataContainer.mutableBound(key: String, type: PersistentDataType<P, C>, default: () -> C): MutableDefaultBoundEntry<P, C>

Creates a mutable bound entry for a key in the given mutable persistent data container.

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

open override fun remove(element: String): Boolean

Removes the value associated with the specified key from 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.

fun MutablePersistentDataContainer.remove(key: PersistentKey<P, C>): Boolean

Removes the value associated with the specified key from this container.

removeAll

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

Removes all values associated with the specified keys from this container.

retainAll

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

saveTo

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

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

set

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

Sets the value associated with the specified key in this container.

set

operator fun MutablePersistentDataContainer.set(key: PersistentKey<P, C>, value: C)

Sets the value associated with the specified persistent key in this container.

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.

PersistentDataContainerBuilder

Author

Since

See also

Constructors

Properties

Functions