Package org.apache.geode.cache.client

Enum Class ClientRegionShortcut

java.lang.Object
java.lang.Enum<ClientRegionShortcut>
org.apache.geode.cache.client.ClientRegionShortcut
All Implemented Interfaces:
Serializable, Comparable<ClientRegionShortcut>, Constable
public enum ClientRegionShortcut extends Enum<ClientRegionShortcut>
Each enum represents a predefined RegionAttributes in a ClientCache. These enum values can be used to create regions using a ClientRegionFactory obtained by calling ClientCache.createClientRegionFactory(ClientRegionShortcut).

Another way to use predefined region attributes is in cache.xml by setting the refid attribute on a region element or region-attributes element to the string of each value.

Since:
GemFire 6.5

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CACHING_PROXY
    A CACHING_PROXY region has local state but can also send operations to a server.
    CACHING_PROXY_HEAP_LRU
    A CACHING_PROXY_HEAP_LRU region has local state but can also send operations to a server.
    CACHING_PROXY_OVERFLOW
    A CACHING_PROXY_OVERFLOW region has local state but can also send operations to a server.
    LOCAL
    A LOCAL region only has local state and never sends operations to a server.
    LOCAL_HEAP_LRU
    A LOCAL_HEAP_LRU region only has local state and never sends operations to a server.
    LOCAL_OVERFLOW
    A LOCAL_OVERFLOW region only has local state and never sends operations to a server.
    LOCAL_PERSISTENT
    A LOCAL_PERSISTENT region only has local state and never sends operations to a server but it does write its state to disk and can recover that state when the region is created.
    LOCAL_PERSISTENT_OVERFLOW
    A LOCAL_PERSISTENT_OVERFLOW region only has local state and never sends operations to a server but it does write its state to disk and can recover that state when the region is created.
    PROXY
    A PROXY region has no local state and forwards all operations to a server.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ClientRegionShortcut
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ClientRegionShortcut[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static ClientRegionShortcut[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ClientRegionShortcut valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null