NBTCompoundLike

interface NBTCompoundLike : NBTCompoundGetters, Iterable<CompoundEntry>

Functions

asMapView

abstract fun asMapView(): Map<String, NBT>

Returns a Map representing this compound.

contains

open operator fun contains(key: String): Boolean

Checks if the compound contains the given key.

containsKey

open fun containsKey(key: String): Boolean

Returns true if the compound contains the specified key.

containsValue

open fun containsValue(value: NBT): Boolean

Returns true if the compound maps one or more keys to the specified value.

forEach

open fun forEach(p0: Consumer<in Map.Entry<String, NBT>>)

open fun forEach(action: BiConsumer<String, NBT>)

Performs the given action on each entry.

open fun forEach(action: (CompoundEntry) -> Unit)

Performs the given action on each entry.

get

open operator override fun get(key: String): NBT?

Returns the value corresponding to the given key, or null if such a key is not present in the compound.

getAsByte

open fun getAsByte(key: String): Byte?

Calls getNumber and cast to the desired type.

getAsDouble

open fun getAsDouble(key: String): Double?

Calls getNumber and cast to the desired type.

getAsFloat

open fun getAsFloat(key: String): Float?

Calls getNumber and cast to the desired type.

getAsInt

open fun getAsInt(key: String): Int?

Calls getNumber and cast to the desired type.

getAsLong

open fun getAsLong(key: String): Long?

Calls getNumber and cast to the desired type.

getAsShort

open fun getAsShort(key: String): Short?

Calls getNumber and cast to the desired type.

getBoolean

open fun getBoolean(key: String): Boolean?

Returns the value associated to the given key, if any.

getByte

open fun getByte(key: String): Byte?

Returns the value associated to the given key, if any.

getByteArray

open fun getByteArray(key: String): ImmutableByteArray?

Returns the value associated to the given key, if any.

getCompound

open fun getCompound(key: String): NBTCompound?

Returns the value associated to the given key, if any.

getDouble

open fun getDouble(key: String): Double?

Returns the value associated to the given key, if any.

getFloat

open fun getFloat(key: String): Float?

Returns the value associated to the given key, if any.

getInt

open fun getInt(key: String): Int?

Returns the value associated to the given key, if any.

getIntArray

open fun getIntArray(key: String): ImmutableIntArray?

Returns the value associated to the given key, if any.

getList

open fun <T : NBT> getList(key: String): NBTList<T>?

Returns the value associated to the given key, if any.

getLong

open fun getLong(key: String): Long?

Returns the value associated to the given key, if any.

getLongArray

open fun getLongArray(key: String): ImmutableLongArray?

Returns the value associated to the given key, if any.

getNumber

open fun getNumber(key: String): Number?

Returns the value associated to the given key, if any.

getOrElse

open fun getOrElse(key: String, defaultValue: NBT): NBT

Returns the value associated to the given key, if any.

getShort

open fun getShort(key: String): Short?

Returns the value associated to the given key, if any.

getString

open fun getString(key: String): String?

Returns the value associated to the given key, if any.

isEmpty

open fun isEmpty(): Boolean

Returns true if the compound is empty (contains no elements), false otherwise.

iterator

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

Returns an Iterator over the entries in the compound.

plus

abstract operator fun plus(other: NBTCompoundLike): NBTCompoundLike

Creates a new NBTCompoundLike by replacing or adding entries from this compound with entries from 'other'

spliterator

open fun spliterator(): Spliterator<CompoundEntry>

toCompound

@Contract(pure = true)

abstract fun toCompound(): NBTCompound

Creates a NBTCompound.

toMutableCompound

abstract fun toMutableCompound(): MutableNBTCompound

Returns a new mutable map containing all key-value pairs from the original compound.

toSNBT

open fun toSNBT(): String

Same semantics than NBT#toSNBT

Properties

entries

open val entries: Set<CompoundEntry>

Returns a read-only Set of all key/value pairs in this compound.

keys

open val keys: Set<String>

Returns a read-only Set of all keys in this compound.

size

open val size: Int

Returns the number of key/value pairs in the compound.

values

open val values: Collection<NBT>

Returns a read-only Collection of all values in this compound.

Inheritors

NBTCompound

MutableNBTCompound