ReadableNBT (item-nbt-api 2.14.1 API)

All Known Subinterfaces:

NBTFileHandle, ReadableItemNBT, ReadWriteItemNBT, ReadWriteNBT

All Known Implementing Classes:

NBTCompound, NBTContainer, NBTEntity, NBTFile, NBTItem, NBTListCompound, NBTPersistentDataContainer, NBTTileEntity
```
public interface ReadableNBT
```
This interface only exposes methods that get data without any changes to the underlying object.

Author:

tr7zw

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`<T> T`	`get(String key, NBTHandler<T> handler)` Get the object at the specified key via the handler.
`Boolean`	`getBoolean(String key)` Returns the value associated with the given key, or false if the key is not found.
`Byte`	`getByte(String key)` Get the value of the given key as a byte, or 0 if the key is not found.
`byte[]`	`getByteArray(String key)` Returns the value associated with the given key as a byte array, or null if the key is not found.
`ReadableNBT`	`getCompound(String name)`
`ReadableNBTList<ReadWriteNBT>`	`getCompoundList(String name)`
`Double`	`getDouble(String key)` Returns the value associated with the given key as a double, or false of not found.
`ReadableNBTList<Double>`	`getDoubleList(String name)`
`<E extends Enum<E>> E`	`getEnum(String key, Class<E> type)` Get an Enum value that has been set via setEnum or setString(key, value.name()).
`Float`	`getFloat(String key)` Returns the value of the given key as a Float, or 0 if the key does not exist.
`ReadableNBTList<Float>`	`getFloatList(String name)`
`int[]`	`getIntArray(String key)` Returns the value associated with the given key as an array of integers, or null if the key does not exist.
`ReadableNBTList<int[]>`	`getIntArrayList(String name)`
`Integer`	`getInteger(String key)` Given a key, return the value associated with that key as an Integer, or 0 if the key is not found.
`ReadableNBTList<Integer>`	`getIntegerList(String name)`
`org.bukkit.inventory.ItemStack`	`getItemStack(String key)` It returns an ItemStack associated with the given key, or null if the key does not exist.
`org.bukkit.inventory.ItemStack[]`	`getItemStackArray(String key)` Get an `ItemStack` array that was saved at the given key, or null if no stored data was found
`Set<String>`	`getKeys()`
`NBTType`	`getListType(String name)` Returns the type of the list, null if not a list
`Long`	`getLong(String key)` Returns the value associated with the given key as a Long, or 0 if the key is not found.
`long[]`	`getLongArray(String key)` Returns the value associated with the given key as an array of longs, or null if the key does not exist.
`ReadableNBTList<Long>`	`getLongList(String name)`
`<T> T`	`getOrDefault(String key, T defaultValue)` Returns the stored value if exists, or provided value otherwise.
`<T> T`	`getOrNull(String key, Class<?> type)` Returns the stored value if exists, or null.
`Short`	`getShort(String key)` Returns the value of the key as a Short, or 0 if the key is not found.
`String`	`getString(String key)` Given a key, return the value associated with that key.
`ReadableNBTList<String>`	`getStringList(String name)`
`NBTType`	`getType(String name)`
`UUID`	`getUUID(String key)` Given a key, return the UUID of the key.
`ReadableNBTList<UUID>`	`getUUIDList(String name)`
`boolean`	`hasTag(String key)` Checks whether the provided key exists
`default boolean`	`hasTag(String key, NBTType type)` Checks whether the provided key exists and has the specified type
`ReadableNBT`	`resolveCompound(String key)` Returns the resolved Compound if exists, or null.
`<T> T`	`resolveOrDefault(String key, T defaultValue)` Returns the resolved value if exists, or provided value otherwise.
`<T> T`	`resolveOrNull(String key, Class<?> type)` Returns the resolved value if exists, or null.
`String`	`toString()`
`void`	`writeCompound(OutputStream stream)` Write the content of this Compound into the provided stream.

- Method Detail
  - getString
```
String getString(String key)
```
    Given a key, return the value associated with that key.
    
    Parameters:
    
    key - The key to get the value for.
    
    Returns:
    
    The value of the key.
  - getInteger
```
Integer getInteger(String key)
```
    Given a key, return the value associated with that key as an Integer, or 0 if the key is not found.
    
    Parameters:
    
    key - The key to look up in the properties file.
    
    Returns:
    
    The value of the key.
  - getDouble
```
Double getDouble(String key)
```
    Returns the value associated with the given key as a double, or false of not found.
    
    Parameters:
    
    key - The key of the preference to retrieve.
    
    Returns:
    
    A double value
  - getByte
```
Byte getByte(String key)
```
    Get the value of the given key as a byte, or 0 if the key is not found.
    
    Parameters:
    
    key - The key to get the value for.
    
    Returns:
    
    A byte
  - getShort
```
Short getShort(String key)
```
    Returns the value of the key as a Short, or 0 if the key is not found.
    
    Parameters:
    
    key - The key of the value you want to get.
    
    Returns:
    
    A short value
  - getLong
```
Long getLong(String key)
```
    Returns the value associated with the given key as a Long, or 0 if the key is not found.
    
    Parameters:
    
    key - The key of the value you want to get.
    
    Returns:
    
    A Long object
  - getFloat
```
Float getFloat(String key)
```
    Returns the value of the given key as a Float, or 0 if the key does not exist.
    
    Parameters:
    
    key - The key of the preference to retrieve.
    
    Returns:
    
    A float value
  - getByteArray
```
@Nullable
byte[] getByteArray(String key)
```
    Returns the value associated with the given key as a byte array, or null if the key is not found.
    
    Parameters:
    
    key - The key to use to retrieve the value.
    
    Returns:
    
    A byte array.
  - getIntArray
```
@Nullable
int[] getIntArray(String key)
```
    Returns the value associated with the given key as an array of integers, or null if the key does not exist.
    
    Parameters:
    
    key - The key of the value you want to get.
    
    Returns:
    
    An array of integers.
  - getLongArray
```
@Nullable
long[] getLongArray(String key)
```
    Returns the value associated with the given key as an array of longs, or null if the key does not exist. Requires 1.16+
    
    Parameters:
    
    key - The key of the value you want to get.
    
    Returns:
    
    An array of integers.
  - getBoolean
```
Boolean getBoolean(String key)
```
    Returns the value associated with the given key, or false if the key is not found.
    
    Parameters:
    
    key - The key of the preference to retrieve.
    
    Returns:
    
    A boolean value.
  - getItemStack
```
@Nullable
org.bukkit.inventory.ItemStack getItemStack(String key)
```
    It returns an ItemStack associated with the given key, or null if the key does not exist.
    
    Parameters:
    
    key - The key of the itemstack you want to get.
    
    Returns:
    
    An ItemStack
  - getItemStackArray
```
@Nullable
org.bukkit.inventory.ItemStack[] getItemStackArray(String key)
```
    Get an ItemStack array that was saved at the given key, or null if no stored data was found
    
    Parameters:
    
    key - key
    
    Returns:
    
    The stored ItemStack array, or null if stored data wasn't found
  - getUUID
```
@Nullable
UUID getUUID(String key)
```
    Given a key, return the UUID of the key.
    
    Parameters:
    
    key - The key to get the value from
    
    Returns:
    
    A UUID object.
  - hasTag
```
boolean hasTag(String key)
```
    Checks whether the provided key exists
    
    Parameters:
    
    key - String key
    
    Returns:
    
    true, if the key is set
  - hasTag
```
default boolean hasTag(String key,
                       NBTType type)
```
    Checks whether the provided key exists and has the specified type
    
    Parameters:
    
    key - String key
    
    type - nbt tag type
    
    Returns:
    
    whether the key is set and has the specified type
  - getKeys
```
Set<String> getKeys()
```
    Returns:
    
    Set of all stored Keys
  - getCompound
```
@Nullable
ReadableNBT getCompound(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The Compound instance or null
  - getStringList
```
ReadableNBTList<String> getStringList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved String List
  - getIntegerList
```
ReadableNBTList<Integer> getIntegerList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Integer List
  - getIntArrayList
```
ReadableNBTList<int[]> getIntArrayList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Integer List
  - getUUIDList
```
ReadableNBTList<UUID> getUUIDList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Integer List
  - getFloatList
```
ReadableNBTList<Float> getFloatList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Float List
  - getDoubleList
```
ReadableNBTList<Double> getDoubleList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Double List
  - getLongList
```
ReadableNBTList<Long> getLongList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Long List
  - getListType
```
@Nullable
NBTType getListType(String name)
```
    Returns the type of the list, null if not a list
    
    Parameters:
    
    name -
    
    Returns:
  - getCompoundList
```
ReadableNBTList<ReadWriteNBT> getCompoundList(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The retrieved Compound List
  - getOrDefault
```
<T> T getOrDefault(String key,
                   T defaultValue)
```
    Returns the stored value if exists, or provided value otherwise.
    Supported types: Boolean, Byte, Short, Integer, Long, Float, Double, byte[], int[], long[], String, UUID, and Enum
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    key - key
    
    defaultValue - default non-null value
    
    Returns:
    
    Stored or provided value
  - getOrNull
```
@Nullable
<T> T getOrNull(String key,
                          Class<?> type)
```
    Returns the stored value if exists, or null.
    Supported types: Boolean, Byte, Short, Integer, Long, Float, Double, byte[], int[], long[], String, UUID, and Enum
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    key - key
    
    type - data type
    
    Returns:
    
    Stored or provided value
  - resolveOrNull
```
@Nullable
<T> T resolveOrNull(String key,
                              Class<?> type)
```
    Returns the resolved value if exists, or null.
    Supported types: Boolean, Byte, Short, Integer, Long, Float, Double, byte[], int[], long[], String, UUID, and Enum
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    key - Path key, seperated by '.'. For example: "foo.bar.baz". Dots can be escaped with a backslash.
    
    type - data type
    
    Returns:
    
    resolved or provided value
  - resolveOrDefault
```
<T> T resolveOrDefault(String key,
                       T defaultValue)
```
    Returns the resolved value if exists, or provided value otherwise.
    Supported types: Boolean, Byte, Short, Integer, Long, Float, Double, byte[], int[], long[], String, UUID, and Enum
    
    Type Parameters:
    
    T - value type
    
    Parameters:
    
    key - Path key, seperated by '.'. For example: "foo.bar.baz". Dots can be escaped with a backslash.
    
    defaultValue - default non-null value
    
    Returns:
    
    resolved or provided value
  - resolveCompound
```
@Nullable
ReadableNBT resolveCompound(String key)
```
    Returns the resolved Compound if exists, or null.
    
    Parameters:
    
    key - Path key, seperated by '.'. For example: "foo.bar.baz". Dots can be escaped with a backslash.
    
    Returns:
    
    The resolved value if exists, or null.
  - get
```
<T> T get(String key,
          NBTHandler<T> handler)
```
    Get the object at the specified key via the handler.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    key -
    
    handler -
    
    Returns:
  - getEnum
```
@Nullable
<E extends Enum<E>> E getEnum(String key,
                                        Class<E> type)
```
    Get an Enum value that has been set via setEnum or setString(key, value.name()). Passing null/invalid keys will return null.
    
    Type Parameters:
    
    E -
    
    Parameters:
    
    key -
    
    type -
    
    Returns:
  - getType
```
NBTType getType(String name)
```
    Parameters:
    
    name -
    
    Returns:
    
    The type of the given stored key or null
  - writeCompound
```
void writeCompound(OutputStream stream)
```
    Write the content of this Compound into the provided stream.
    
    Parameters:
    
    stream -
  - toString
```
String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The NBT as printable NBT-Json.

Interface ReadableNBT

Method Summary

Method Detail

getString

getInteger

getDouble

getByte

getShort

getLong

getFloat

getByteArray

getIntArray

getLongArray

getBoolean

getItemStack

getItemStackArray

getUUID

hasTag

hasTag

getKeys

getCompound

getStringList

getIntegerList

getIntArrayList

getUUIDList

getFloatList

getDoubleList

getLongList

getListType

getCompoundList

getOrDefault

getOrNull

resolveOrNull

resolveOrDefault

resolveCompound

get

getEnum

getType

writeCompound

toString