org.oscim.core

Class TagSet

java.lang.Object

org.oscim.core.TagSet

public class TagSet
extends java.lang.Object

The Class TagSet holds a set of Tags.

Constructor Summary

Constructors

Constructor and Description
TagSet() Instantiates a new TagSet with initial size of 10.
TagSet(int size) Instantiates a new tag set initialized with the given size.

Method Summary

Modifier and Type	Method and Description
void	add(Tag tag) Adds the Tag tag to TagSet.
Tag[]	asArray() Return Tags contained in TagSet as new array.
void	clear() Reset the TagSet to contain 0 tags.
void	clearAndNullTags() Clear.
boolean	contains(java.lang.String key, java.lang.String value) Checks if a Tag with given key and value is contained in TagSet.
boolean	contains(Tag tag) Checks if 'tag' is contained in TagSet.
boolean	containsKey(java.lang.String key) Checks if any tag has the key 'key'.
Tag	get(int index) Find Tag by given index.
Tag	get(java.lang.String key) Find Tag by given key.
Tag[]	getTags() Return Tags array contained in TagSet.
java.lang.String	getValue(java.lang.String key) Get the value for a given key.
void	set(Tag[] tagArray) Sets the tags from 'tagArray'.
void	set(TagSet tagSet) Sets the tags from 'tagSet'.
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TagSet

public TagSet()

Instantiates a new TagSet with initial size of 10.

TagSet

public TagSet(int size)

Instantiates a new tag set initialized with the given size.

Parameters:

size - the initial size.

Method Detail

clear

public void clear()

Reset the TagSet to contain 0 tags.

size

public int size()

Returns:

Size of TagSet

clearAndNullTags

public void clearAndNullTags()

Clear. Reset the TagSet to contain 0 tags and null out tags.

asArray

public Tag[] asArray()

Return Tags contained in TagSet as new array.

Returns:

the tag[]

get

public Tag get(int index)

Find Tag by given index.

Parameters:

index - the index of tag.

Returns:

the tag if found, null otherwise.

get

public Tag get(java.lang.String key)

Find Tag by given key.

Parameters:

key - the key as intern String.

Returns:

the tag if found, null otherwise.

getTags

public Tag[] getTags()

Return Tags array contained in TagSet.

Returns:

the tags array.

containsKey

public boolean containsKey(java.lang.String key)

Checks if any tag has the key 'key'.

Parameters:

key - the key as intern String.

Returns:

true, if any tag has the given key

getValue

public java.lang.String getValue(java.lang.String key)

Get the value for a given key.

Parameters:

key - the key as intern String

Returns:

the value when found, null otherwise

add

public void add(Tag tag)

Adds the Tag tag to TagSet.

Parameters:

tag - the Tag to be added

set

public void set(Tag[] tagArray)

Sets the tags from 'tagArray'.

Parameters:

tagArray - the tag array

set

public void set(TagSet tagSet)

Sets the tags from 'tagSet'.

Parameters:

tagSet - the tag set

contains

public boolean contains(Tag tag)

Checks if 'tag' is contained in TagSet.

Parameters:

tag - the tag

Returns:

true, iff tag is in TagSet

contains

public boolean contains(java.lang.String key,
                        java.lang.String value)

Checks if a Tag with given key and value is contained in TagSet.

Parameters:

key - the key as intern String

value - the value as intern String

Returns:

true, iff any tag has the given key and value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object