Package net.sf.ehcache

Class Status

  • All Implemented Interfaces:
    java.io.Serializable
    public final class Status
extends java.lang.Object
implements java.io.Serializable
    A pre JDK1.5 compatible enum class to indicate the status of a CacheManager or Cache.

    ehcache historically used int values for status. This is unsuitable for third party use thus this class. Methods are provided to convert from the int status values to enum values and vice versa.

    Since:
    1.2
    Version:
    $Id$
    Author:
    Greg Luck
    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Status convertIntToStatus​(int statusAsInt)  
      boolean equals​(java.lang.Object object)
      Indicates whether some other object is "equal to" this one.
      boolean equals​(Status status)
      Equality checker when the comparison object is of the same type.
      int hashCode()
      Returns a hash code value for Status.
      int intValue()
      Returns the int value of status, for backward compatibility with ehcache versions below 1.2
      java.lang.String toString()
      Returns a string representation of the object.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • STATUS_UNINITIALISED

        public static final Status STATUS_UNINITIALISED
        The cache is uninitialised. It cannot be used.

      • STATUS_ALIVE

        public static final Status STATUS_ALIVE
        The cache is alive. It can be used.

      • STATUS_SHUTDOWN

        public static final Status STATUS_SHUTDOWN
        The cache is shudown. It cannot be used.

    • Method Detail

      • toString

        public java.lang.String toString()
        Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

        The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

         getClass().getName() + '@' + Integer.toHexString(hashCode())
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the object.

      • convertIntToStatus

        public static Status convertIntToStatus​(int statusAsInt)
                                 throws java.lang.IllegalArgumentException
        Parameters:
        statusAsInt - an int argument between 1 and 3.
        Returns:
        an enum Status
        Throws:
        java.lang.IllegalArgumentException - if the argument is not between 1 and 3

      • intValue

        public int intValue()
        Returns the int value of status, for backward compatibility with ehcache versions below 1.2
        Returns:
        the int value of this status.

      • equals

        public boolean equals​(java.lang.Object object)
        Indicates whether some other object is "equal to" this one.

        The equals method implements an equivalence relation on non-null object references:

        • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
        • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
        • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
        • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
        • For any non-null reference value x, x.equals(null) should return false.
        The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

        Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

        Overrides:
        equals in class java.lang.Object
        Parameters:
        object - the reference object with which to compare.
        Returns:
        true if this object is the same as the obj argument; false otherwise.
        See Also:
        hashCode(), Hashtable

      • equals

        public boolean equals​(Status status)
        Equality checker when the comparison object is of the same type.
        Parameters:
        status - the status to check
        Returns:
        true is the statuses are the same

      • hashCode

        public int hashCode()
        Returns a hash code value for Status. It is the underlying int value of the status.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a hash code value for this object.
        See Also:
        Object.hashCode(), Hashtable