com.github.steveice10.opennbt

Class SNBTIO

java.lang.Object

com.github.steveice10.opennbt.SNBTIO

public class SNBTIO
extends Object

A class containing methods for reading/writing stringified NBT tags.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SNBTIO.StringifiedNBTReader
static class	SNBTIO.StringifiedNBTWriter

Constructor Summary

Constructors

Constructor and Description
SNBTIO()

Method Summary

Modifier and Type	Method and Description
static CompoundTag	readFile(File file) Reads the stringified CompoundTag from the given file.
static CompoundTag	readFile(String path) Reads stringified root CompoundTag from the given file.
static Tag	readTag(InputStream in) Reads a stringified NBT tag.
static void	writeFile(CompoundTag tag, File file) Writes the given root CompoundTag to the given file as stringified NBT.
static void	writeFile(CompoundTag tag, File file, boolean linebreak) Writes the given root CompoundTag to the given file as stringified NBT.
static void	writeFile(CompoundTag tag, String path) Writes the given root CompoundTag to the given file as stringified NBT.
static void	writeFile(CompoundTag tag, String path, boolean linebreak) Writes the given root CompoundTag to the given file as stringified NBT.
static void	writeTag(OutputStream out, Tag tag) Writes a stringified NBT tag.
static void	writeTag(OutputStream out, Tag tag, boolean linebreak) Writes a stringified NBT tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

SNBTIO

public SNBTIO()

Method Detail

readFile

public static CompoundTag readFile(String path)
                            throws IOException

Reads stringified 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 stringified CompoundTag from the given file.

Parameters:

file - File to read from.

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 as stringified NBT.

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 as stringified NBT.

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 linebreak)
                      throws IOException

Writes the given root CompoundTag to the given file as stringified NBT.

Parameters:

tag - Tag to write.

path - Path to write to.

linebreak - Whether the SNBT file should be formated with line breaks or as a single line.

Throws:

IOException - If an I/O error occurs.

writeFile

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

Writes the given root CompoundTag to the given file as stringified NBT.

Parameters:

tag - Tag to write.

file - File to write to.

linebreak - Whether the SNBT file should be formated with line breaks or as a single line.

Throws:

IOException - If an I/O error occurs.

readTag

public static Tag readTag(InputStream in)
                   throws IOException

Reads a stringified 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.

writeTag

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

Writes a stringified NBT tag.

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 linebreak)
                     throws IOException

Writes a stringified NBT tag.

Parameters:

out - Output stream to write to.

tag - Tag to write.

linebreak - Whether the SNBT should be formated with line breaks or as a single line.

Throws:

IOException - If an I/O error occurs.