Package net.glowstone.util.nbt

Class NbtInputStream

java.lang.Object

net.glowstone.util.nbt.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	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.

Method Summary

Modifier and Type	Method	Description
void	close()
CompoundTag	readCompound()	Reads the root NBT CompoundTag from the stream.
CompoundTag	readCompound(NbtReadLimiter readLimiter)	Reads the root NBT CompoundTag from the stream.

Methods inherited from class java.lang.Object

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

Constructor Details

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.

Parameters:

is - The input stream.

compressed - A flag indicating if the stream is compressed.

Throws:

IOException - if an I/O error occurs.

Method Details

readCompound

public CompoundTag readCompound()
                         throws IOException

Reads the root NBT CompoundTag from the stream.

Returns:

The tag that was read.

Throws:

IOException - if an I/O error occurs.

readCompound

public CompoundTag readCompound(NbtReadLimiter readLimiter)
                         throws IOException

Reads the root NBT CompoundTag from the stream.

Parameters:

readLimiter - The read limiter to prevent overflow when reading the NBT data.

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 AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException