xyz.nickr.nbt

Enum NBTCompression

java.lang.Object

java.lang.Enum<NBTCompression>

xyz.nickr.nbt.NBTCompression

All Implemented Interfaces:

Serializable, Comparable<NBTCompression>

public enum NBTCompression
extends Enum<NBTCompression>

Represents the different compression options supported by NBT.

Author:

Nick Robson

Enum Constant Summary

Enum Constants

Enum Constant and Description
DETECTED Detects what compression the data stream uses, then extracts and compresses using it.
GZIP Represents a data stream compressed using GZip.
UNCOMPRESSED Represents an uncompressed data stream.
ZLIB Represents a data stream compressed using ZLib.

Method Summary

Modifier and Type	Method and Description
abstract io.netty.buffer.ByteBuf	compress(io.netty.buffer.ByteBuf buf) Compresses a given ByteBuf.
static NBTCompression	detect(io.netty.buffer.ByteBuf buf) Detects and retrieves the compression used on the given ByteBuf.
static NBTCompression	detect(InputStream is) Detects and retrieves the compression used on the given InputStream.
abstract io.netty.buffer.ByteBuf	extract(io.netty.buffer.ByteBuf buf) Extracts a given ByteBuf.
static NBTCompression	valueOf(String name) Returns the enum constant of this type with the specified name.
static NBTCompression[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNCOMPRESSED

public static final NBTCompression UNCOMPRESSED

Represents an uncompressed data stream.

GZIP

public static final NBTCompression GZIP

Represents a data stream compressed using GZip.

ZLIB

public static final NBTCompression ZLIB

Represents a data stream compressed using ZLib.

DETECTED

public static final NBTCompression DETECTED

Detects what compression the data stream uses, then extracts and compresses using it.

Method Detail

values

public static NBTCompression[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NBTCompression c : NBTCompression.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NBTCompression valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

extract

public abstract io.netty.buffer.ByteBuf extract(io.netty.buffer.ByteBuf buf)

Extracts a given ByteBuf.

Parameters:

buf - The buffer to be extracted.

Returns:

The extracted buffer.

compress

public abstract io.netty.buffer.ByteBuf compress(io.netty.buffer.ByteBuf buf)

Compresses a given ByteBuf.

Parameters:

buf - The buffer to be compressed.

Returns:

The compressed buffer.

detect

public static NBTCompression detect(io.netty.buffer.ByteBuf buf)

Detects and retrieves the compression used on the given ByteBuf.

Parameters:

buf - The buffer to check the compression of.

Returns:

The compression stream, or UNCOMPRESSED if not recognized.

detect

public static NBTCompression detect(InputStream is)

Detects and retrieves the compression used on the given InputStream.

Parameters:

is - The input stream to check the compression of.

Returns:

The compression stream, or UNCOMPRESSED if not recognized.