com.flowpowered.nbt.stream

Class NBTOutputStream

java.lang.Object

com.flowpowered.nbt.stream.NBTOutputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class NBTOutputStream
extends Object
implements Closeable

This class writes NBT, or Named Binary Tag, Tag objects to an underlying OutputStream.

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
NBTOutputStream(OutputStream os) Creates a new NBTOutputStream, which will write data to the specified underlying output stream.
NBTOutputStream(OutputStream os, boolean compressed) Creates a new NBTOutputStream, which will write data to the specified underlying output stream.
NBTOutputStream(OutputStream os, boolean compressed, ByteOrder endianness) Creates a new NBTOutputStream, which will write data to the specified underlying output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flushes the stream
ByteOrder	getEndianness()
void	writeTag(Tag<?> tag) Writes a tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

NBTOutputStream

public NBTOutputStream(OutputStream os)
                throws IOException

Creates a new NBTOutputStream, which will write data to the specified underlying output stream. This assumes the output stream should be compressed with GZIP.

Parameters:

os - The output stream.

Throws:

IOException - if an I/O error occurs.

NBTOutputStream

public NBTOutputStream(OutputStream os,
                       boolean compressed)
                throws IOException

Creates a new NBTOutputStream, which will write data to the specified underlying output stream. A flag indicates if the output should be compressed with GZIP or not.

Parameters:

os - The output stream.

compressed - A flag that indicates if the output should be compressed.

Throws:

IOException - if an I/O error occurs.

NBTOutputStream

public NBTOutputStream(OutputStream os,
                       boolean compressed,
                       ByteOrder endianness)
                throws IOException

Creates a new NBTOutputStream, which will write data to the specified underlying output stream. A flag indicates if the output should be compressed with GZIP or not.

Parameters:

os - The output stream.

compressed - A flag that indicates if the output should be compressed.

endianness - A flag that indicates if numbers in the output should be output in little-endian format.

Throws:

IOException - if an I/O error occurs.

Method Detail

writeTag

public void writeTag(Tag<?> tag)
              throws IOException

Writes a tag.

Parameters:

tag - The tag to write.

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

getEndianness

public ByteOrder getEndianness()

Returns:

whether this NBTInputStream writes numbers in little-endian format.

flush

public void flush()
           throws IOException

Flushes the stream

Throws:

IOException