com.github.steveice10.opennbt.tag.builtin

Class Tag

java.lang.Object

com.github.steveice10.opennbt.tag.builtin.Tag

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ByteArrayTag, ByteTag, CompoundTag, DoubleArrayTag, DoubleTag, FloatArrayTag, FloatTag, IntArrayTag, IntTag, ListTag, LongArrayTag, LongTag, ShortArrayTag, ShortTag, StringTag

public abstract class Tag
extends Object
implements Cloneable

Represents an NBT tag.

All tags must have a constructor with a single string parameter for reading tags (can be any visibility). Tags should also have setter methods specific to their value types.

Constructor Summary

Constructors

Constructor and Description
Tag(String name) Creates a tag with the specified name.

Method Summary

Modifier and Type	Method and Description
abstract Tag	clone()
abstract void	destringify(SNBTIO.StringifiedNBTReader in) Parses this tag from stringified NBT.
boolean	equals(Object obj)
String	getName() Gets the name of this tag.
abstract Object	getValue() Gets the value of this tag.
abstract void	read(DataInput in) Reads this tag from an input stream.
abstract void	stringify(SNBTIO.StringifiedNBTWriter out, boolean linebreak, int depth) Write this tag as stringified NBT.
String	toString()
abstract void	write(DataOutput out) Writes this tag to an output stream.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Tag

public Tag(String name)

Creates a tag with the specified name.

Parameters:

name - The name.

Method Detail

getName

public final String getName()

Gets the name of this tag.

Returns:

The name of this tag.

getValue

public abstract Object getValue()

Gets the value of this tag.

Returns:

The value of this tag.

read

public abstract void read(DataInput in)
                   throws IOException

Reads this tag from an input stream.

Parameters:

in - Stream to read from.

Throws:

IOException - If an I/O error occurs.

write

public abstract void write(DataOutput out)
                    throws IOException

Writes this tag to an output stream.

Parameters:

out - Stream to write to.

Throws:

IOException - If an I/O error occurs.

destringify

public abstract void destringify(SNBTIO.StringifiedNBTReader in)
                          throws IOException

Parses this tag from stringified NBT.

Parameters:

in - String to parse.

Throws:

IOException

stringify

public abstract void stringify(SNBTIO.StringifiedNBTWriter out,
                               boolean linebreak,
                               int depth)
                        throws IOException

Write this tag as stringified NBT.

Throws:

IOException

clone

public abstract Tag clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object