GemFire 7.0.1

com.gemstone.gemfire.cache
Class InterestResultPolicy

java.lang.Object
  extended by com.gemstone.gemfire.cache.InterestResultPolicy
All Implemented Interfaces:
Serializable

public class InterestResultPolicy
extends Object
implements Serializable

Class InterestResultPolicy is an enumerated type for a register interest result. The result of a call to Region.registerInterest can be the keys and current values, just the keys or nothing.

Since:
4.2.3
See Also:
Region.registerInterest(Object), Region.registerInterestRegex(String), Serialized Form

Field Summary
static InterestResultPolicy DEFAULT
          The InterestResultPolicy used by default; it is KEYS_VALUES.
static InterestResultPolicy KEYS
           
static InterestResultPolicy KEYS_VALUES
           
static InterestResultPolicy NONE
           
 byte ordinal
          The ordinal representing this InterestResultPolicy.
 
Method Summary
static InterestResultPolicy fromOrdinal(byte ordinal)
          Returns the InterestResultPolicy represented by specified ordinal
 byte getOrdinal()
          Returns the ordinal value.
 boolean isDefault()
          Returns true if this InterestResultPolicy is the default.
 boolean isKeys()
          Returns true if this InterestResultPolicy is KEYS.
 boolean isKeysValues()
          Returns true if this InterestResultPolicy is KEYS_VALUES.
 boolean isNone()
          Returns true if this InterestResultPolicy is NONE.
 String toString()
          Returns a string representation for this InterestResultPolicy.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NONE

public static final InterestResultPolicy NONE

KEYS

public static final InterestResultPolicy KEYS

KEYS_VALUES

public static final InterestResultPolicy KEYS_VALUES

DEFAULT

public static final InterestResultPolicy DEFAULT
The InterestResultPolicy used by default; it is KEYS_VALUES.


ordinal

public final byte ordinal
The ordinal representing this InterestResultPolicy.

Method Detail

fromOrdinal

public static InterestResultPolicy fromOrdinal(byte ordinal)
Returns the InterestResultPolicy represented by specified ordinal


getOrdinal

public byte getOrdinal()
Returns the ordinal value.

Since:
5.0

isNone

public boolean isNone()
Returns true if this InterestResultPolicy is NONE.

Returns:
true if this InterestResultPolicy is NONE.

isKeys

public boolean isKeys()
Returns true if this InterestResultPolicy is KEYS.

Returns:
true if this InterestResultPolicy is KEYS.

isKeysValues

public boolean isKeysValues()
Returns true if this InterestResultPolicy is KEYS_VALUES.

Returns:
true if this InterestResultPolicy is KEYS_VALUES.

isDefault

public boolean isDefault()
Returns true if this InterestResultPolicy is the default.

Returns:
true if this InterestResultPolicy is the default.

toString

public String toString()
Returns a string representation for this InterestResultPolicy.

Overrides:
toString in class Object
Returns:
the name of this data policy.

GemFire 7.0.1

Copyright © 1997-2013 VMware, Inc. All rights reserved.