me.ryandw11.ods.tags

Class InvalidTag

java.lang.Object

me.ryandw11.ods.tags.InvalidTag

All Implemented Interfaces:

Tag<byte[]>

public class InvalidTag
extends java.lang.Object
implements Tag<byte[]>

This tag represents a CustomTag that has not been defined using ODS.registerCustomTag(Tag).

ODS will only return this tag when the ODS.allowUndefinedTags(boolean) is enabled.

This class is not to be constructed.

Constructor Summary

Constructors

Constructor and Description
InvalidTag(java.lang.String name) Deprecated. Do not use this constructor.

Method Summary

Modifier and Type	Method and Description
Tag<byte[]>	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.
byte[]	getValue() Get the value of the tag.
void	setName(java.lang.String name) Set the name of the tag
void	setValue(byte[] bytes) Set the value of the tag
void	writeData(java.io.DataOutputStream dos) Write the data of the tag to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidTag

public InvalidTag(java.lang.String name)

Deprecated. Do not use this constructor.

Construct an invalid tag.

Parameters:

name - The name.

Method Detail

getValue

public byte[] getValue()

Description copied from interface: Tag

Get the value of the tag.

Specified by:

getValue in interface Tag<byte[]>

Returns:

The value

setValue

public void setValue(byte[] bytes)

Description copied from interface: Tag

Set the value of the tag

Specified by:

setValue in interface Tag<byte[]>

Parameters:

bytes - The value

getName

public java.lang.String getName()

Description copied from interface: Tag

Get the name of the tag.

Specified by:

getName in interface Tag<byte[]>

Returns:

The name of the tag.

setName

public void setName(java.lang.String name)

Description copied from interface: Tag

Set the name of the tag

Specified by:

setName in interface Tag<byte[]>

Parameters:

name - The name

writeData

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

Description copied from interface: Tag

Write the data of the tag to an output stream.

Specified by:

writeData in interface Tag<byte[]>

Parameters:

dos - The output stream.

Throws:

java.io.IOException - If something goes wrong.

createFromData

public Tag<byte[]> createFromData(java.nio.ByteBuffer value,
                                  int length)

Description copied from interface: Tag

Turn an array of bytes into the Tag.

Specified by:

createFromData in interface Tag<byte[]>

Parameters:

value - The array of bytes

length - The size of the value in bytes.

Returns:

The instance of the tag.

getID

public byte getID()

Description copied from interface: Tag

Get the ID of the tag.

Specified by:

getID in interface Tag<byte[]>

Returns:

The ID.