Package com.alachisoft.ncache.runtime.cacheloader

Enum RefreshPreference

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RefreshPreference>
    public enum RefreshPreference
extends java.lang.Enum<RefreshPreference>
    This enum represents different RefreshPreferences to refresh the required dataset.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      RefreshNow
      Immediately refreshes the dataset.
      RefreshOnNextTimeOfDay
      Refreshes the dataset anytime within the next 24 hours.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static RefreshPreference forValue​(int value)
      Retrieves the enum constant of the specified value, if exists.
      int getValue()
      Order is important in enums.
      static RefreshPreference valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RefreshPreference[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • RefreshNow

        public static final RefreshPreference RefreshNow
        Immediately refreshes the dataset.

      • RefreshOnNextTimeOfDay

        public static final RefreshPreference RefreshOnNextTimeOfDay
        Refreshes the dataset anytime within the next 24 hours.

    • Method Detail

      • values

        public static RefreshPreference[] 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 (RefreshPreference c : RefreshPreference.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static RefreshPreference 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

      • forValue

        public static RefreshPreference forValue​(int value)
        Retrieves the enum constant of the specified value, if exists.
        Parameters:
        value - Enum constant index.
        Returns:
        Enum constant.

      • getValue

        public int getValue()
        Order is important in enums. By using getValue() method, each enum constant index can be found, just like array index.
        Returns:
        Enum constant index.