me.ryandw11.ods

Interface Tag<T>

Type Parameters:

T - The object that the tag is representing.

All Known Implementing Classes:

ByteTag, CharTag, CompressedObjectTag, DoubleTag, FloatTag, IntTag, InvalidTag, ListTag, LongTag, MapTag, ObjectTag, ShortTag, StringTag

public interface Tag<T>

The main tag interface.

Method Summary

Modifier and Type	Method and Description
Tag<T>	createFromData(java.nio.ByteBuffer value, int length) Turn an array of bytes into the Tag.
byte	getID() Get the ID of the tag.
java.lang.String	getName() Get the name of the tag.
T	getValue() Get the value of the tag.
void	setName(java.lang.String name) Set the name of the tag
void	setValue(T t) Set the value of the tag
void	writeData(java.io.DataOutputStream dos) Write the data of the tag to an output stream.

Method Detail

getValue

T getValue()

Get the value of the tag.

Returns:

The value

setValue

void setValue(T t)

Set the value of the tag

Parameters:

t - The value

getName

java.lang.String getName()

Get the name of the tag.

Returns:

The name of the tag.

setName

void setName(java.lang.String name)

Set the name of the tag

Parameters:

name - The name

writeData

void writeData(java.io.DataOutputStream dos)
        throws java.io.IOException

Write the data of the tag to an output stream.

Parameters:

dos - The output stream.

Throws:

java.io.IOException - If something goes wrong.

createFromData

Tag<T> createFromData(java.nio.ByteBuffer value,
                      int length)

Turn an array of bytes into the Tag.

Parameters:

value - The array of bytes

length - The size of the value in bytes.

Returns:

The instance of the tag.

getID

byte getID()

Get the ID of the tag.

Returns:

The ID.