org.jnbt

Class NBTInputStream

java.lang.Object

org.jnbt.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 http://www.minecraft.net/docs/NBT.txt.

Constructor Summary

Constructors

Constructor and Description
NBTInputStream(InputStream is) Creates a new NBTInputStream, which will source its data from the specified input stream, which is assumed to contain big endian data, or if the input stream is already a DataInput stream, the stream's default byte order.
NBTInputStream(InputStream is, boolean littleEndian) Creates a new NBTInputStream, which will source its data from the specified input stream.

Method Summary

Modifier and Type	Method and Description
void	close()
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)

Creates a new NBTInputStream, which will source its data from the specified input stream, which is assumed to contain big endian data, or if the input stream is already a DataInput stream, the stream's default byte order.

Parameters:

is - The input stream.

NBTInputStream

public NBTInputStream(InputStream is,
                      boolean littleEndian)

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

Parameters:

is - The input stream.

littleEndian - Whether the stream contains little endian data.

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