com.comphenix.attribute

Class NbtFactory

java.lang.Object

com.comphenix.attribute.NbtFactory

public class NbtFactory
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NbtFactory.NbtCompound Represents a root NBT compound.
class	NbtFactory.NbtList Represents a root NBT list.
static class	NbtFactory.StreamOptions Whether or not to enable stream compression.
static interface	NbtFactory.Wrapper Represents an object that provides a view of a native NMS class.

Method Summary

Modifier and Type	Method and Description
static NbtFactory.NbtCompound	createCompound() Construct a new NBT compound.
static NbtFactory.NbtList	createList(java.lang.Iterable<? extends java.lang.Object> iterable) Construct a new NBT list of an unspecified type.
static NbtFactory.NbtList	createList(java.lang.Object... content) Construct a new NBT list of an unspecified type.
static NbtFactory.NbtCompound	fromCompound(java.lang.Object nmsCompound) Construct a new NBT wrapper from a compound.
static NbtFactory.NbtCompound	fromItemTag(org.bukkit.inventory.ItemStack stack) Construct a wrapper for an NBT tag stored (in memory) in an item stack.
static NbtFactory.NbtList	fromList(java.lang.Object nmsList) Construct a new NBT wrapper from a list.
static NbtFactory.NbtCompound	fromStream(com.google.common.io.ByteSource stream, NbtFactory.StreamOptions option) Load the content of a file from a stream.
static org.bukkit.inventory.ItemStack	getCraftItemStack(org.bukkit.inventory.ItemStack stack) Retrieve a CraftItemStack version of the stack.
static void	saveStream(NbtFactory.NbtCompound source, com.google.common.io.ByteSink stream, NbtFactory.StreamOptions option) Save the content of a NBT compound to a stream.
static void	setItemTag(org.bukkit.inventory.ItemStack stack, NbtFactory.NbtCompound compound) Set the NBT compound tag of a given item stack.

Methods inherited from class java.lang.Object

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

Method Detail

createList

public static NbtFactory.NbtList createList(java.lang.Object... content)

Construct a new NBT list of an unspecified type.

Returns:

The NBT list.

createList

public static NbtFactory.NbtList createList(java.lang.Iterable<? extends java.lang.Object> iterable)

Construct a new NBT list of an unspecified type.

Returns:

The NBT list.

createCompound

public static NbtFactory.NbtCompound createCompound()

Construct a new NBT compound.

Returns:

The NBT compound.

fromList

public static NbtFactory.NbtList fromList(java.lang.Object nmsList)

Construct a new NBT wrapper from a list.

Parameters:

nmsList - - the NBT list.

Returns:

The wrapper.

fromStream

public static NbtFactory.NbtCompound fromStream(com.google.common.io.ByteSource stream,
                                                NbtFactory.StreamOptions option)
                                         throws java.io.IOException

Load the content of a file from a stream.

Use Files#newInputStreamSupplier(java.io.File) to provide a stream from a file.

Parameters:

stream - - the stream supplier.

option - - whether or not to decompress the input stream.

Returns:

The decoded NBT compound.

Throws:

java.io.IOException - If anything went wrong.

saveStream

public static void saveStream(NbtFactory.NbtCompound source,
                              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:

source - - the NBT compound to save.

stream - - the stream.

option - - whether or not to compress the output.

Throws:

java.io.IOException - If anything went wrong.

fromCompound

public static NbtFactory.NbtCompound fromCompound(java.lang.Object nmsCompound)

Construct a new NBT wrapper from a compound.

Parameters:

nmsCompound - - the NBT compund.

Returns:

The wrapper.

setItemTag

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

Set the NBT compound tag of a given item stack.

The item stack must be a wrapper for a CraftItemStack.

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 NbtFactory.NbtCompound 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 does not include items material, damage value or count.

The item stack must be a wrapper for a CraftItemStack.

Parameters:

stack - - the item stack.

Returns:

A wrapper for its NBT tag.

getCraftItemStack

public static org.bukkit.inventory.ItemStack getCraftItemStack(org.bukkit.inventory.ItemStack stack)

Retrieve a CraftItemStack version of the stack.

Parameters:

stack - - the stack to convert.

Returns:

The CraftItemStack version.