Package com.alachisoft.ncache.client.datastructures

Class DataStructureAttributes

  • public class DataStructureAttributes
extends java.lang.Object
    DataStructureAttributes contains the information about the DataStructures.

    • Constructor Summary

      Constructors 
      Constructor Description
      DataStructureAttributes()
      Initializes DataTypeAttributes instance with default cache item priority.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CacheDependency getDependency()
      Get the file or cache key dependencies for the DataStructure.
      Expiration getExpiration()
      Gets the expiration mechanism for DataStructure.
      java.lang.String getGroup()
      Gets the associated Group with the DataStructure.
      NamedTagsDictionary getNamedTags()
      Gets the NamedTags information associated with the DataStructure, it can be queried on the basis of NamedTags provided.
      CacheItemPriority getPriority()
      Gets the relative priority for DataStructure which is kept under consideration whenever cache starts to free up space and evicts items.
      ResyncOptions getResyncOptions()
      Gets the ResyncOptions specific to the DataStructure.
      java.util.List<Tag> getTags()
      Gets the tags information associated with the DataStructure, it can be queried on the basis of Tags provided.
      void setDependency​(CacheDependency value)
      Sets the file or cache key dependencies for the DataType.
      void setExpiration​(Expiration value)
      Sets the expiration mechanism for DataStructure.
      void setGroup​(java.lang.String value)
      Sets the Group associated with the DataStructure.
      void setNamedTags​(NamedTagsDictionary value)
      Sets the NamedTags information associated with the DataStructure, it can be queried on the basis of NamedTags provided.
      void setPriority​(CacheItemPriority value)
      Sets the relative priority for DataStructure which is kept under consideration whenever cache starts to free up space and evicts items.
      void setResyncOptions​(ResyncOptions value)
      Sets the ResyncOptions specific to the DataStructure.
      void setTags​(java.util.List<Tag> value)
      Sets the tags information associated with the DataStructure, it can be queried on the basis of Tags provided.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DataStructureAttributes

        public DataStructureAttributes()
        Initializes DataTypeAttributes instance with default cache item priority.

    • Method Detail

      • getExpiration

        public final Expiration getExpiration()
        Gets the expiration mechanism for DataStructure.
        Returns:
        Expiration instance that contains info about DataStructure expiration mechanism.

      • setExpiration

        public final void setExpiration​(Expiration value)
        Sets the expiration mechanism for DataStructure.
        Parameters:
        value - Expiration object that specifies the expiration mechanism for DataStructure.

      • getDependency

        public final CacheDependency getDependency()
        Get the file or cache key dependencies for the DataStructure. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this property contains a null reference.
        Returns:
        The file or cache key dependencies for the DataStructure.

      • setDependency

        public final void setDependency​(CacheDependency value)
        Sets the file or cache key dependencies for the DataType. When any dependency changes, the object becomes invalid and is removed from the cache. If there are no dependencies, this property contains a null reference.
        Parameters:
        value - The file or cache key dependencies for the DataType.

      • getGroup

        public final java.lang.String getGroup()
        Gets the associated Group with the DataStructure. It can be queried on the basis of Groups.
        Returns:
        The Group associated with DataStructure.

      • setGroup

        public final void setGroup​(java.lang.String value)
        Sets the Group associated with the DataStructure. It can be queried on the basis of Groups.
        Parameters:
        value - The Group to be associated with DataStructure.

      • getResyncOptions

        public final ResyncOptions getResyncOptions()
        Gets the ResyncOptions specific to the DataStructure.
        Returns:
        ResyncOptions specific to the DataStructure.

      • setResyncOptions

        public final void setResyncOptions​(ResyncOptions value)
        Sets the ResyncOptions specific to the DataStructure.
        Parameters:
        value - ResyncOptions specific to the DataStructure.

      • getNamedTags

        public final NamedTagsDictionary getNamedTags()
        Gets the NamedTags information associated with the DataStructure, it can be queried on the basis of NamedTags provided.
        Returns:
        NamedTags associated with DataStructure.

      • setNamedTags

        public final void setNamedTags​(NamedTagsDictionary value)
        Sets the NamedTags information associated with the DataStructure, it can be queried on the basis of NamedTags provided.
        Parameters:
        value - NamedTags to be associated with DataStructure.

      • getTags

        public final java.util.List<Tag> getTags()
        Gets the tags information associated with the DataStructure, it can be queried on the basis of Tags provided.
        Returns:
        List of Tags associated with DataStructure.

      • setTags

        public final void setTags​(java.util.List<Tag> value)
        Sets the tags information associated with the DataStructure, it can be queried on the basis of Tags provided.
        Parameters:
        value - List of Tags to be associated with DataStructure.

      • getPriority

        public final CacheItemPriority getPriority()
        Gets the relative priority for DataStructure which is kept under consideration whenever cache starts to free up space and evicts items.
        Returns:
        CacheItemPriority associated with DataStructure.

      • setPriority

        public final void setPriority​(CacheItemPriority value)
        Sets the relative priority for DataStructure which is kept under consideration whenever cache starts to free up space and evicts items.
        Parameters:
        value - CacheItemPriority to be associated with DataStructure.