com.flowpowered.nbt.stream

Class NBTInputStream

java.lang.Object

com.flowpowered.nbt.stream.NBTInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class NBTInputStream
extends Object
implements Closeable

This class reads NBT, or Named Binary Tag streams, and produces an object graph of subclasses of the Tag object.

The NBT format was created by Markus Persson, and the specification may be found at https://flowpowered.com/nbt/spec.txt.

Constructor Summary

Constructors

Constructor and Description
NBTInputStream(InputStream is) Creates a new NBTInputStream, which will source its data from the specified input stream.
NBTInputStream(InputStream is, boolean compressed) Creates a new NBTInputStream, which sources its data from the specified input stream.
NBTInputStream(InputStream is, boolean compressed, ByteOrder endianness) Creates a new NBTInputStream, which sources its data from the specified input stream.

Method Summary

Modifier and Type	Method and Description
void	close()
ByteOrder	getByteOrder()
Tag	readTag() Reads an NBT Tag from the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

NBTInputStream

public NBTInputStream(InputStream is)
               throws IOException

Creates a new NBTInputStream, which will source its data from the specified input stream. This assumes the stream is compressed.

Parameters:

is - The input stream.

Throws:

IOException - if an I/O error occurs.

NBTInputStream

public NBTInputStream(InputStream is,
                      boolean compressed)
               throws IOException

Creates a new NBTInputStream, which sources its data from the specified input stream. A flag must be passed which indicates if the stream is compressed with GZIP or not. This assumes the stream uses big endian encoding.

Parameters:

is - The input stream.

compressed - A flag indicating if the stream is compressed.

Throws:

IOException - if an I/O error occurs.

NBTInputStream

public NBTInputStream(InputStream is,
                      boolean compressed,
                      ByteOrder endianness)
               throws IOException

Creates a new NBTInputStream, which sources its data from the specified input stream. A flag must be passed which indicates if the stream is compressed with GZIP or not.

Parameters:

is - The input stream.

compressed - A flag indicating if the stream is compressed.

endianness - Whether to read numbers from the InputStream with little endian encoding.

Throws:

IOException - if an I/O error occurs.

Method Detail

readTag

public Tag readTag()
            throws IOException

Reads an NBT Tag from the stream.

Returns:

The tag that was read.

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getByteOrder

public ByteOrder getByteOrder()

Returns:

whether this NBTInputStream reads numbers in little-endian format.