com.comphenix.protocol.wrappers.nbt

Class NbtFactory

java.lang.Object

com.comphenix.protocol.wrappers.nbt.NbtFactory

public class NbtFactory
extends java.lang.Object

Factory methods for creating NBT elements, lists and compounds.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
NbtFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static NbtCompound	asCompound(NbtBase<?> tag) Attempt to cast this NBT tag as a compund.
static NbtList<?>	asList(NbtBase<?> tag) Attempt to cast this NBT tag as a list.
static <T> NbtWrapper<T>	fromBase(NbtBase<T> base) Get a NBT wrapper from a NBT base.
static NbtCompound	fromFile(java.lang.String file) Load a NBT compound from a GZIP compressed file.
static NbtWrapper<?>	fromItemTag(org.bukkit.inventory.ItemStack stack) Construct a wrapper for an NBT tag stored (in memory) in an item stack.
static <T> NbtWrapper<T>	fromNMS(java.lang.Object handle) Deprecated.
static <T> NbtWrapper<T>	fromNMS(java.lang.Object handle, java.lang.String name) Initialize a NBT wrapper with a name.
static NbtCompound	fromNMSCompound(java.lang.Object handle) Retrieve the NBT compound from a given NMS handle.
static NbtBase<java.lang.Byte>	of(java.lang.String name, byte value) Constructs a NBT tag of type byte.
static NbtBase<byte[]>	of(java.lang.String name, byte[] value) Constructs a NBT tag of type byte array.
static NbtBase<java.lang.Double>	of(java.lang.String name, double value) Constructs a NBT tag of type double.
static NbtBase<java.lang.Float>	of(java.lang.String name, float value) Constructs a NBT tag of type float.
static NbtBase<java.lang.Integer>	of(java.lang.String name, int value) Constructs a NBT tag of type int.
static NbtBase<int[]>	of(java.lang.String name, int[] value) Constructs a NBT tag of type int array.
static NbtBase<java.lang.Long>	of(java.lang.String name, long value) Constructs a NBT tag of type long.
static NbtBase<java.lang.Short>	of(java.lang.String name, short value) Constructs a NBT tag of type short.
static NbtBase<java.lang.String>	of(java.lang.String name, java.lang.String value) Constructs a NBT tag of type string.
static NbtCompound	ofCompound(java.lang.String name) Construct a new NBT compound wrapper.
static NbtCompound	ofCompound(java.lang.String name, java.util.Collection<? extends NbtBase<?>> list) Construct a new NBT compound initialized with a given list of NBT values.
static <T> NbtList<T>	ofList(java.lang.String name, java.util.Collection<? extends T> elements) Construct a NBT list of out a list of values.
static <T> NbtList<T>	ofList(java.lang.String name, T... elements) Construct a NBT list of out an array of values.
static <T> NbtWrapper<T>	ofWrapper(java.lang.Class<?> type, java.lang.String name, T value) Create a new NBT wrapper from a given type.
static <T> NbtWrapper<T>	ofWrapper(NbtType type, java.lang.String name) Create a new NBT wrapper from a given type.
static <T> NbtWrapper<T>	ofWrapper(NbtType type, java.lang.String name, T value) Create a new NBT wrapper from a given type.
static void	setItemTag(org.bukkit.inventory.ItemStack stack, NbtCompound compound) Set the NBT compound tag of a given item stack.
static void	toFile(NbtCompound compound, java.lang.String file) Save a NBT compound to a new compressed file, overwriting any existing files in the process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NbtFactory

public NbtFactory()

Method Detail

asCompound

public static NbtCompound asCompound(NbtBase<?> tag)

Attempt to cast this NBT tag as a compund.

Parameters:

tag - - the NBT tag to cast.

Returns:

This instance as a compound.

Throws:

java.lang.UnsupportedOperationException - If this is not a compound.

asList

public static NbtList<?> asList(NbtBase<?> tag)

Attempt to cast this NBT tag as a list.

Parameters:

tag - - the NBT tag to cast.

Returns:

This instance as a list.

Throws:

java.lang.UnsupportedOperationException - If this is not a list.

fromBase

public static <T> NbtWrapper<T> fromBase(NbtBase<T> base)

Get a NBT wrapper from a NBT base.

This may clone the content if the NbtBase is not a NbtWrapper.

Parameters:

base - - the base class.

Returns:

A NBT wrapper.

setItemTag

public static void setItemTag(org.bukkit.inventory.ItemStack stack,
              NbtCompound compound)

Set the NBT compound tag of a given item stack.

The item stack must be a wrapper for a CraftItemStack. Use MinecraftReflection.getBukkitItemStack(ItemStack) if not.

Parameters:

stack - - the item stack, cannot be air.

compound - - the new NBT compound, or NULL to remove it.

Throws:

java.lang.IllegalArgumentException - If the stack is not a CraftItemStack, or it represents air.

fromItemTag

public static NbtWrapper<?> fromItemTag(org.bukkit.inventory.ItemStack stack)

Construct a wrapper for an NBT tag stored (in memory) in an item stack. This is where auxillary data such as enchanting, name and lore is stored. It doesn't include the items material, damage value or count.

The item stack must be a wrapper for a CraftItemStack. Use MinecraftReflection.getBukkitItemStack(ItemStack) if not.

Parameters:

stack - - the item stack.

Returns:

A wrapper for its NBT tag.

fromFile

public static NbtCompound fromFile(java.lang.String file)
                            throws java.io.IOException

Load a NBT compound from a GZIP compressed file.

Parameters:

file - - the source file.

Returns:

The compound.

Throws:

java.io.IOException - Unable to load file.

toFile

public static void toFile(NbtCompound compound,
          java.lang.String file)
                   throws java.io.IOException

Save a NBT compound to a new compressed file, overwriting any existing files in the process.

Parameters:

compound - - the compound to save.

file - - the destination file.

Throws:

java.io.IOException - Unable to save compound.

fromNMS

@Deprecated
public static <T> NbtWrapper<T> fromNMS(java.lang.Object handle)

Deprecated.

Initialize a NBT wrapper.

Use fromNMS(Object, String) instead.

Parameters:

handle - - the underlying net.minecraft.server object to wrap.

Returns:

A NBT wrapper.

fromNMS

public static <T> NbtWrapper<T> fromNMS(java.lang.Object handle,
                        java.lang.String name)

Initialize a NBT wrapper with a name.

Parameters:

name - - the name of the tag, or NULL if not valid.

handle - - the underlying net.minecraft.server object to wrap.

Returns:

A NBT wrapper.

fromNMSCompound

public static NbtCompound fromNMSCompound(@Nonnull
                          java.lang.Object handle)

Retrieve the NBT compound from a given NMS handle.

Parameters:

handle - - the underlying net.minecraft.server object to wrap.

Returns:

A NBT compound wrapper

of

public static NbtBase<java.lang.String> of(java.lang.String name,
                           java.lang.String value)

Constructs a NBT tag of type string.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<java.lang.Byte> of(java.lang.String name,
                         byte value)

Constructs a NBT tag of type byte.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<java.lang.Short> of(java.lang.String name,
                          short value)

Constructs a NBT tag of type short.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<java.lang.Integer> of(java.lang.String name,
                            int value)

Constructs a NBT tag of type int.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<java.lang.Long> of(java.lang.String name,
                         long value)

Constructs a NBT tag of type long.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<java.lang.Float> of(java.lang.String name,
                          float value)

Constructs a NBT tag of type float.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<java.lang.Double> of(java.lang.String name,
                           double value)

Constructs a NBT tag of type double.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<byte[]> of(java.lang.String name,
                 byte[] value)

Constructs a NBT tag of type byte array.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

of

public static NbtBase<int[]> of(java.lang.String name,
                int[] value)

Constructs a NBT tag of type int array.

Parameters:

name - - name of the tag.

value - - value of the tag.

Returns:

The constructed NBT tag.

ofCompound

public static NbtCompound ofCompound(java.lang.String name,
                     java.util.Collection<? extends NbtBase<?>> list)

Construct a new NBT compound initialized with a given list of NBT values.

Parameters:

name - - the name of the compound wrapper.

list - - the list of elements to add.

Returns:

The new wrapped NBT compound.

ofCompound

public static NbtCompound ofCompound(java.lang.String name)

Construct a new NBT compound wrapper.

Parameters:

name - - the name of the compound wrapper.

Returns:

The new wrapped NBT compound.

ofList

public static <T> NbtList<T> ofList(java.lang.String name,
                    T... elements)

Construct a NBT list of out an array of values.

Parameters:

name - - name of this list.

elements - - elements to add.

Returns:

The new filled NBT list.

ofList

public static <T> NbtList<T> ofList(java.lang.String name,
                    java.util.Collection<? extends T> elements)

Construct a NBT list of out a list of values.

Parameters:

name - - name of this list.

elements - - elements to add.

Returns:

The new filled NBT list.

ofWrapper

public static <T> NbtWrapper<T> ofWrapper(NbtType type,
                          java.lang.String name)

Create a new NBT wrapper from a given type.

Parameters:

type - - the NBT type.

name - - the name of the NBT tag.

Returns:

The new wrapped NBT tag.

Throws:

FieldAccessException - If we're unable to create the underlying tag.

ofWrapper

public static <T> NbtWrapper<T> ofWrapper(NbtType type,
                          java.lang.String name,
                          T value)

Create a new NBT wrapper from a given type.

Parameters:

type - - the NBT type.

name - - the name of the NBT tag.

value - - the value of the new tag.

Returns:

The new wrapped NBT tag.

Throws:

FieldAccessException - If we're unable to create the underlying tag.

ofWrapper

public static <T> NbtWrapper<T> ofWrapper(java.lang.Class<?> type,
                          java.lang.String name,
                          T value)

Create a new NBT wrapper from a given type.

Parameters:

type - - type of the NBT value.

name - - the name of the NBT tag.

value - - the value of the new tag.

Returns:

The new wrapped NBT tag.

Throws:

FieldAccessException - If we're unable to create the underlying tag.

java.lang.IllegalArgumentException - If the given class type is not valid NBT.