com.github.steveice10.opennbt

Class NBTIO

java.lang.Object

com.github.steveice10.opennbt.NBTIO

public class NBTIO
extends Object

A class containing methods for reading/writing NBT tags.

Constructor Summary

Constructors

Constructor and Description
NBTIO()

Method Summary

Modifier and Type	Method and Description
static CompoundTag	readFile(File file) Reads the compressed, big endian root CompoundTag from the given file.
static CompoundTag	readFile(File file, boolean compressed, boolean littleEndian) Reads the root CompoundTag from the given file.
static CompoundTag	readFile(String path) Reads the compressed, big endian root CompoundTag from the given file.
static CompoundTag	readFile(String path, boolean compressed, boolean littleEndian) Reads the root CompoundTag from the given file.
static Tag	readTag(DataInput in) Reads an NBT tag.
static Tag	readTag(InputStream in) Reads a big endian NBT tag.
static Tag	readTag(InputStream in, boolean littleEndian) Reads an NBT tag.
static void	writeFile(CompoundTag tag, File file) Writes the given root CompoundTag to the given file, compressed and in big endian.
static void	writeFile(CompoundTag tag, File file, boolean compressed, boolean littleEndian) Writes the given root CompoundTag to the given file.
static void	writeFile(CompoundTag tag, String path) Writes the given root CompoundTag to the given file, compressed and in big endian.
static void	writeFile(CompoundTag tag, String path, boolean compressed, boolean littleEndian) Writes the given root CompoundTag to the given file.
static void	writeTag(DataOutput out, Tag tag) Writes an NBT tag.
static void	writeTag(OutputStream out, Tag tag) Writes an NBT tag in big endian.
static void	writeTag(OutputStream out, Tag tag, boolean littleEndian) Writes an NBT tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

NBTIO

public NBTIO()

Method Detail

readFile

public static CompoundTag readFile(String path)
                            throws IOException

Reads the compressed, big endian root CompoundTag from the given file.

Parameters:

path - Path of the file.

Returns:

The read compound tag.

Throws:

IOException - If an I/O error occurs.

readFile

public static CompoundTag readFile(File file)
                            throws IOException

Reads the compressed, big endian root CompoundTag from the given file.

Parameters:

file - File to read from.

Returns:

The read compound tag.

Throws:

IOException - If an I/O error occurs.

readFile

public static CompoundTag readFile(String path,
                                   boolean compressed,
                                   boolean littleEndian)
                            throws IOException

Reads the root CompoundTag from the given file.

Parameters:

path - Path of the file.

compressed - Whether the NBT file is compressed.

littleEndian - Whether the NBT file is little endian.

Returns:

The read compound tag.

Throws:

IOException - If an I/O error occurs.

readFile

public static CompoundTag readFile(File file,
                                   boolean compressed,
                                   boolean littleEndian)
                            throws IOException

Reads the root CompoundTag from the given file.

Parameters:

file - File to read from.

compressed - Whether the NBT file is compressed.

littleEndian - Whether the NBT file is little endian.

Returns:

The read compound tag.

Throws:

IOException - If an I/O error occurs.

writeFile

public static void writeFile(CompoundTag tag,
                             String path)
                      throws IOException

Writes the given root CompoundTag to the given file, compressed and in big endian.

Parameters:

tag - Tag to write.

path - Path to write to.

Throws:

IOException - If an I/O error occurs.

writeFile

public static void writeFile(CompoundTag tag,
                             File file)
                      throws IOException

Writes the given root CompoundTag to the given file, compressed and in big endian.

Parameters:

tag - Tag to write.

file - File to write to.

Throws:

IOException - If an I/O error occurs.

writeFile

public static void writeFile(CompoundTag tag,
                             String path,
                             boolean compressed,
                             boolean littleEndian)
                      throws IOException

Writes the given root CompoundTag to the given file.

Parameters:

tag - Tag to write.

path - Path to write to.

compressed - Whether the NBT file should be compressed.

littleEndian - Whether to write little endian NBT.

Throws:

IOException - If an I/O error occurs.

writeFile

public static void writeFile(CompoundTag tag,
                             File file,
                             boolean compressed,
                             boolean littleEndian)
                      throws IOException

Writes the given root CompoundTag to the given file.

Parameters:

tag - Tag to write.

file - File to write to.

compressed - Whether the NBT file should be compressed.

littleEndian - Whether to write little endian NBT.

Throws:

IOException - If an I/O error occurs.

readTag

public static Tag readTag(InputStream in)
                   throws IOException

Reads a big endian NBT tag.

Parameters:

in - Input stream to read from.

Returns:

The read tag, or null if the tag is an end tag.

Throws:

IOException - If an I/O error occurs.

readTag

public static Tag readTag(InputStream in,
                          boolean littleEndian)
                   throws IOException

Reads an NBT tag.

Parameters:

in - Input stream to read from.

littleEndian - Whether to read little endian NBT.

Returns:

The read tag, or null if the tag is an end tag.

Throws:

IOException - If an I/O error occurs.

readTag

public static Tag readTag(DataInput in)
                   throws IOException

Reads an NBT tag.

Parameters:

in - Data input to read from.

Returns:

The read tag, or null if the tag is an end tag.

Throws:

IOException - If an I/O error occurs.

writeTag

public static void writeTag(OutputStream out,
                            Tag tag)
                     throws IOException

Writes an NBT tag in big endian.

Parameters:

out - Output stream to write to.

tag - Tag to write.

Throws:

IOException - If an I/O error occurs.

writeTag

public static void writeTag(OutputStream out,
                            Tag tag,
                            boolean littleEndian)
                     throws IOException

Writes an NBT tag.

Parameters:

out - Output stream to write to.

tag - Tag to write.

littleEndian - Whether to write little endian NBT.

Throws:

IOException - If an I/O error occurs.

writeTag

public static void writeTag(DataOutput out,
                            Tag tag)
                     throws IOException

Writes an NBT tag.

Parameters:

out - Data output to write to.

tag - Tag to write.

Throws:

IOException - If an I/O error occurs.