com.comphenix.attribute

Class NbtFactory.NbtCompound

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.comphenix.attribute.NbtFactory.NbtCompound

All Implemented Interfaces:

NbtFactory.Wrapper, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

NbtFactory

public final class NbtFactory.NbtCompound
extends java.util.AbstractMap<java.lang.String,java.lang.Object>

Represents a root NBT compound.

All changes to this map will be reflected in the underlying NBT compound. Values may only be one of the following:

• Primitive types
• String
• NbtFactory.NbtList
• NbtFactory.NbtCompound

See also:

• NbtFactory.createCompound()
• NbtFactory.fromCompound(Object)

Author:

Kristian

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
java.lang.Byte	getByte(java.lang.String key, java.lang.Byte defaultValue)
byte[]	getByteArray(java.lang.String key, byte[] defaultValue)
java.lang.Double	getDouble(java.lang.String key, java.lang.Double defaultValue)
java.lang.Float	getFloat(java.lang.String key, java.lang.Float defaultValue)
java.lang.Integer	getInteger(java.lang.String key, java.lang.Integer defaultValue)
int[]	getIntegerArray(java.lang.String key, int[] defaultValue)
NbtFactory.NbtList	getList(java.lang.String key, boolean createNew) Retrieve the list by the given name.
java.lang.Long	getLong(java.lang.String key, java.lang.Long defaultValue)
NbtFactory.NbtCompound	getMap(java.lang.String key, boolean createNew) Retrieve the map by the given name.
<T> T	getPath(java.lang.String path) Retrieve the value of a given entry in the tree.
java.lang.Short	getShort(java.lang.String key, java.lang.Short defaultValue)
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue)
NbtFactory.NbtCompound	putPath(java.lang.String path, java.lang.Object value) Set the value of an entry at a given location.
NbtFactory.NbtCompound	saveTo(com.google.common.io.ByteSink stream, NbtFactory.StreamOptions option) Save the content of a NBT compound to a stream.

Methods inherited from class java.util.AbstractMap

clear, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getByte

public java.lang.Byte getByte(java.lang.String key,
                              java.lang.Byte defaultValue)

getShort

public java.lang.Short getShort(java.lang.String key,
                                java.lang.Short defaultValue)

getInteger

public java.lang.Integer getInteger(java.lang.String key,
                                    java.lang.Integer defaultValue)

getLong

public java.lang.Long getLong(java.lang.String key,
                              java.lang.Long defaultValue)

getFloat

public java.lang.Float getFloat(java.lang.String key,
                                java.lang.Float defaultValue)

getDouble

public java.lang.Double getDouble(java.lang.String key,
                                  java.lang.Double defaultValue)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

getByteArray

public byte[] getByteArray(java.lang.String key,
                           byte[] defaultValue)

getIntegerArray

public int[] getIntegerArray(java.lang.String key,
                             int[] defaultValue)

getList

public NbtFactory.NbtList getList(java.lang.String key,
                                  boolean createNew)

Retrieve the list by the given name.

Parameters:

key - - the name of the list.

createNew - - whether or not to create a new list if its missing.

Returns:

An existing list, a new list or NULL.

getMap

public NbtFactory.NbtCompound getMap(java.lang.String key,
                                     boolean createNew)

Retrieve the map by the given name.

Parameters:

key - - the name of the map.

createNew - - whether or not to create a new map if its missing.

Returns:

An existing map, a new map or NULL.

putPath

public NbtFactory.NbtCompound putPath(java.lang.String path,
                                      java.lang.Object value)

Set the value of an entry at a given location.

Every element of the path (except the end) are assumed to be compounds, and will be created if they are missing.

Parameters:

path - - the path to the entry.

value - - the new value of this entry.

Returns:

This compound, for chaining.

getPath

public <T> T getPath(java.lang.String path)

Retrieve the value of a given entry in the tree.

Every element of the path (except the end) are assumed to be compounds. The retrieval operation will be cancelled if any of them are missing.

Parameters:

path - - path to the entry.

Returns:

The value, or NULL if not found.

saveTo

public NbtFactory.NbtCompound saveTo(com.google.common.io.ByteSink stream,
                                     NbtFactory.StreamOptions option)
                              throws java.io.IOException

Save the content of a NBT compound to a stream.

Use Files#newOutputStreamSupplier(java.io.File) to provide a stream supplier to a file.

Parameters:

stream - - the output stream.

option - - whether or not to compress the output.

Throws:

java.io.IOException - If anything went wrong.