Enum RemovalCause

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RemovalCause>

    public enum RemovalCause
    extends java.lang.Enum<RemovalCause>
    The reason why a cached entry was removed.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COLLECTED
      The entry was removed automatically because its key or value was garbage-collected.
      EXPIRED
      The entry's expiration timestamp has passed.
      EXPLICIT
      The entry was manually removed by the user.
      REPLACED
      The entry itself was not actually removed, but its value was replaced by the user.
      SIZE
      The entry was evicted due to size constraints.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private RemovalCause()  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      static RemovalCause valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RemovalCause[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      abstract boolean wasEvicted()
      Returns true if there was an automatic removal due to eviction (the cause is neither EXPLICIT nor REPLACED).
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • RemovalCause

        private RemovalCause()
    • Method Detail

      • values

        public static RemovalCause[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (RemovalCause c : RemovalCause.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RemovalCause valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • wasEvicted

        public abstract boolean wasEvicted()
        Returns true if there was an automatic removal due to eviction (the cause is neither EXPLICIT nor REPLACED).
        Returns:
        if the entry was automatically removed due to eviction