me.ryandw11.ods.tags

Class CompressedObjectTag

java.lang.Object

me.ryandw11.ods.tags.CompressedObjectTag

All Implemented Interfaces:

Tag<java.util.List<Tag<?>>>

public class CompressedObjectTag
extends java.lang.Object
implements Tag<java.util.List<Tag<?>>>

Any tags within the CompressedObject will be compressed using the specified compressor when being written to a file or memory.

Tags within a compressed object cannot be obtained using ObjectDataStructure.get(String) or similar methods. Attempting to will result in a CompressedObjectException.

Constructor Summary

Constructors

Constructor and Description
CompressedObjectTag(java.lang.String name) Construct an compressed object tag with not existing tags.
CompressedObjectTag(java.lang.String name, Compressor compressor) Construct a compressed object tag with no existing tags.
CompressedObjectTag(java.lang.String name, java.util.List<Tag<?>> value, Compressor compressor) Construct a compressed object tag with existing tags.

Method Summary

Modifier and Type	Method and Description
void	addTag(Tag<?> t) Add a tag to the object.
Tag<java.util.List<Tag<?>>>	createFromData(java.nio.ByteBuffer value, int length) Turn an array of bytes into the Tag.
Compressor	getCompressor() Get the compressor used.
byte	getID() Get the ID of the tag.
java.lang.String	getName() Get the name of the tag.
Tag<?>	getTag(java.lang.String name) Get a tag from the object.
java.util.List<Tag<?>>	getValue() Get the value of the tag.
boolean	hasTag(java.lang.String name) If the object has a specified tag.
void	removeAllTags() Remove all tags from an object.
void	removeTag(java.lang.String name) Remove all tags that have the specified name.
void	removeTag(Tag<?> tag) Remove the specified tag from the object.
void	setName(java.lang.String name) Set the name of the tag
void	setValue(java.util.List<Tag<?>> s) 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

CompressedObjectTag

public CompressedObjectTag(java.lang.String name,
                           java.util.List<Tag<?>> value,
                           Compressor compressor)

Construct a compressed object tag with existing tags.

Parameters:

name - The name of the object.

value - The list of tags to add.

compressor - The compressor to use.

CompressedObjectTag

public CompressedObjectTag(java.lang.String name,
                           Compressor compressor)

Construct a compressed object tag with no existing tags.

Parameters:

name - The name of the object.

compressor - The compressor to use.

CompressedObjectTag

public CompressedObjectTag(java.lang.String name)

Construct an compressed object tag with not existing tags.

GZIP Compression is used by default.

Parameters:

name - The name of the tag.

Method Detail

addTag

public void addTag(Tag<?> t)

Add a tag to the object.

Parameters:

t - The tag to add.

getTag

public Tag<?> getTag(java.lang.String name)

Get a tag from the object.

Parameters:

name - The name of the tag.

Returns:

The tag. (Returns null if not found).

removeTag

public void removeTag(Tag<?> tag)

Remove the specified tag from the object.

Parameters:

tag - The tag to remove.

removeTag

public void removeTag(java.lang.String name)

Remove all tags that have the specified name.

Parameters:

name - The name to remove.

removeAllTags

public void removeAllTags()

Remove all tags from an object.

hasTag

public boolean hasTag(java.lang.String name)

If the object has a specified tag.

Parameters:

name - The tag's name.

Returns:

The tag.

getCompressor

public Compressor getCompressor()

Get the compressor used.

Returns:

The compressor used.

setValue

public void setValue(java.util.List<Tag<?>> s)

Description copied from interface: Tag

Set the value of the tag

Specified by:

setValue in interface Tag<java.util.List<Tag<?>>>

Parameters:

s - The value

getValue

public java.util.List<Tag<?>> getValue()

Description copied from interface: Tag

Get the value of the tag.

Specified by:

getValue in interface Tag<java.util.List<Tag<?>>>

Returns:

The value

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<java.util.List<Tag<?>>>

Parameters:

name - The name

getName

public java.lang.String getName()

Description copied from interface: Tag

Get the name of the tag.

Specified by:

getName in interface Tag<java.util.List<Tag<?>>>

Returns:

The name of the tag.

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<java.util.List<Tag<?>>>

Parameters:

dos - The output stream.

Throws:

java.io.IOException - If something goes wrong.

createFromData

public Tag<java.util.List<Tag<?>>> 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<java.util.List<Tag<?>>>

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<java.util.List<Tag<?>>>

Returns:

The ID.