Class TaggableObject

java.lang.Object
com.scaleout.client.caching.query.TaggableObject
All Implemented Interfaces:
Taggable, Serializable

public class TaggableObject extends Object implements Taggable, Serializable
An implementation of Taggable.
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    Construct the taggable object.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addTags(String... tags)
    Adds the tags specified in the tags to the object's tag list.
    void
    Clears all tags from the object's tag list.
    com.scaleout.client.messaging.messages.TagHolder
    Method used by Cache to store tags as SOSS attributes.
    boolean
    hasAllTags(String... tags)
    Determines whether this object has all the tags specified by tags.
    boolean
    hasAnyTags(String... tags)
    Determines whether this object has any of the tags specified by tags.
    void
    removeTags(String... tags)
    Removes the tags specified in the tags from object's tag list.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • TaggableObject

      public TaggableObject()
      Construct the taggable object.
  • Method Details

    • getTags

      public com.scaleout.client.messaging.messages.TagHolder getTags()
      Description copied from interface: Taggable
      Method used by Cache to store tags as SOSS attributes. It should return a reference to a TagHolder object associated with this class.
      Specified by:
      getTags in interface Taggable
      Returns:
      a TagHolder
    • hasAllTags

      public boolean hasAllTags(String... tags) throws CacheException
      Determines whether this object has all the tags specified by tags.
      Parameters:
      tags - tag list
      Returns:
      true if all tags are present, false otherwise
      Throws:
      CacheException - if unexpected exception occurs
    • hasAnyTags

      public boolean hasAnyTags(String... tags) throws CacheException
      Determines whether this object has any of the tags specified by tags.
      Parameters:
      tags - tag list
      Returns:
      true if any tags are present, false otherwise
      Throws:
      CacheException - if unexpected exception occurs
    • addTags

      public void addTags(String... tags) throws CacheException
      Adds the tags specified in the tags to the object's tag list.
      Parameters:
      tags - tags to add
      Throws:
      CacheException - if unexpected exception occurs
    • removeTags

      public void removeTags(String... tags) throws CacheException
      Removes the tags specified in the tags from object's tag list.
      Parameters:
      tags - tags to remove
      Throws:
      CacheException - if unexpected exception occurs
    • clearTags

      public void clearTags()
      Clears all tags from the object's tag list.