com.scaleoutsoftware.soss.client

Class TagHolder

java.lang.Object

com.scaleoutsoftware.soss.client.TagHolder

All Implemented Interfaces:

Externalizable, Serializable

public final class TagHolder
extends Object
implements Externalizable

This class is used as a holder for tags associated with an object. Classes implementing Taggable should encapsulate an instance of TagHolder. There should be one instance of this class per taggable object.

See Also:

Taggable, TaggableObject, FilterFactory.hasAllTags(String...), FilterFactory.hasAnyTags(String...), Serialized Form

Constructor Summary

Constructors

Constructor and Description
TagHolder() Constructs an instance of TagHolder.

Method Summary

Modifier and Type	Method and Description
void	addTags(String... tags) Adds the tags specified in the tags to the current tag list.
void	clearTags() Clears all tags from the holder.
com.scaleoutsoftware.soss.client.query.SparseBitmap	getTags()
boolean	hasAllTags(String... tags) Determines whether this holder has all of the tags specified by tags.
boolean	hasAnyTags(String... tags) Determines whether this holder has any of the tags specified by tags.
void	readExternal(ObjectInput in)
void	removeTags(String... tags) Removes the tags specified in the tags from the current tag list.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

TagHolder

public TagHolder()

Constructs an instance of TagHolder.

Method Detail

addTags

public void addTags(String... tags)
             throws NamedCacheException

Adds the tags specified in the tags to the current tag list.

Parameters:

tags - tags to add

Throws:

NamedCacheException - if unexpected exception occurs

removeTags

public void removeTags(String... tags)
                throws NamedCacheException

Removes the tags specified in the tags from the current tag list.

Parameters:

tags - tags to remove

Throws:

NamedCacheException - if unexpected exception occurs

hasAllTags

public boolean hasAllTags(String... tags)
                   throws NamedCacheException

Determines whether this holder has all of the tags specified by tags.

Parameters:

tags - tag list

Returns:

true if all tags are present, false otherwise

Throws:

NamedCacheException - if unexpected exception occurs

hasAnyTags

public boolean hasAnyTags(String... tags)
                   throws NamedCacheException

Determines whether this holder has any of the tags specified by tags.

Parameters:

tags - tag list

Returns:

true if any tags are present, false otherwise

Throws:

NamedCacheException - if unexpected exception occurs

clearTags

public void clearTags()

Clears all tags from the holder.

getTags

public com.scaleoutsoftware.soss.client.query.SparseBitmap getTags()

Returns:

SparseBitmap containing tag information.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException