net.lenni0451.mcstructs.nbt.io

Class NbtReadTracker

java.lang.Object

net.lenni0451.mcstructs.nbt.io.NbtReadTracker

public class NbtReadTracker
extends java.lang.Object

The Nbt read tracker is used to limit the size of Nbt data that is read.
If you do not want any size constraints you can use unlimitedDepth().

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_MAX_BYTES	The default max bytes that can be read.
static int	DEFAULT_MAX_DEPTH	The default max depth that can be read.

Constructor Summary

Constructors

Constructor	Description
NbtReadTracker()	Create a new read tracker with the default max bytes (DEFAULT_MAX_BYTES) and max depth (DEFAULT_MAX_DEPTH).
NbtReadTracker(int maxDepth, long maxBytes)	Create a new read tracker with the given max bytes and max depth.
NbtReadTracker(long maxBytes)	Create a new read tracker with the given max bytes and the default max depth (DEFAULT_MAX_DEPTH).

Method Summary

Modifier and Type	Method	Description
void	popDepth()	Pop a depth level.
void	pushDepth()	Push a new depth level.
void	read(long bytes)	Read the given amount of bytes.
void	read(long bytes, long multiplier)	Read the given amount of bytes multiplied by the given multiplier.
static NbtReadTracker	unlimitedDepth()	Create an unlimited bytes read tracker.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_BYTES

public static final long DEFAULT_MAX_BYTES

The default max bytes that can be read.

See Also:

Constant Field Values

DEFAULT_MAX_DEPTH

public static final int DEFAULT_MAX_DEPTH

The default max depth that can be read.

See Also:

Constant Field Values

Constructor Detail

NbtReadTracker

public NbtReadTracker()

Create a new read tracker with the default max bytes (DEFAULT_MAX_BYTES) and max depth (DEFAULT_MAX_DEPTH).

NbtReadTracker

public NbtReadTracker(long maxBytes)

Create a new read tracker with the given max bytes and the default max depth (DEFAULT_MAX_DEPTH).

Parameters:

maxBytes - The max bytes that can be read

NbtReadTracker

public NbtReadTracker(int maxDepth,
                      long maxBytes)

Create a new read tracker with the given max bytes and max depth.

Parameters:

maxDepth - The max depth that can be read

maxBytes - The max bytes that can be read

Method Detail

unlimitedDepth

public static NbtReadTracker unlimitedDepth()

Create an unlimited bytes read tracker.
The depth (DEFAULT_MAX_DEPTH) is still limited.

Returns:

The unlimited read tracker

pushDepth

public void pushDepth()
               throws NbtReadException

Push a new depth level.

Throws:

NbtReadException - If the max depth is reached

popDepth

public void popDepth()

Pop a depth level.

read

public void read(long bytes)
          throws NbtReadException

Read the given amount of bytes.

Parameters:

bytes - The amount of bytes that were read

Throws:

NbtReadException - If the max bytes were exceeded

read

public void read(long bytes,
                 long multiplier)
          throws NbtReadException

Read the given amount of bytes multiplied by the given multiplier.

Parameters:

bytes - The amount of bytes that were read

multiplier - The multiplier

Throws:

NbtReadException - If the max bytes were exceeded