Gemfire JavaDocs
Package org.apache.geode.cache
Class InterestResultPolicy
- java.lang.Object
-
- org.apache.geode.cache.InterestResultPolicy
-
- All Implemented Interfaces:
java.io.Serializable
public class InterestResultPolicy extends java.lang.Object implements java.io.Serializable
ClassInterestResultPolicy
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:
- GemFire 4.2.3
- See Also:
Region.registerInterest(Object)
,Region.registerInterestRegex(String)
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static InterestResultPolicy
DEFAULT
TheInterestResultPolicy
used by default; it isKEYS_VALUES
.static InterestResultPolicy
KEYS
static InterestResultPolicy
KEYS_VALUES
static InterestResultPolicy
NONE
byte
ordinal
The ordinal representing thisInterestResultPolicy
.
-
Constructor Summary
Constructors Modifier Constructor Description protected
InterestResultPolicy(java.lang.String name, int ordinal)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InterestResultPolicy
fromOrdinal(byte ordinal)
Returns theInterestResultPolicy
represented by specified ordinalbyte
getOrdinal()
Returns the ordinal value.boolean
isDefault()
Returns true if thisInterestResultPolicy
is the default.boolean
isKeys()
Returns true if thisInterestResultPolicy
isKEYS
.boolean
isKeysValues()
Returns true if thisInterestResultPolicy
isKEYS_VALUES
.boolean
isNone()
Returns true if thisInterestResultPolicy
isNONE
.protected java.lang.Object
readResolve()
java.lang.String
toString()
Returns a string representation for thisInterestResultPolicy
.
-
-
-
Field Detail
-
NONE
@Immutable public static final InterestResultPolicy NONE
-
KEYS
@Immutable public static final InterestResultPolicy KEYS
-
KEYS_VALUES
@Immutable public static final InterestResultPolicy KEYS_VALUES
-
DEFAULT
@Immutable public static final InterestResultPolicy DEFAULT
TheInterestResultPolicy
used by default; it isKEYS_VALUES
.
-
ordinal
public final byte ordinal
The ordinal representing thisInterestResultPolicy
.
-
-
Method Detail
-
readResolve
protected java.lang.Object readResolve() throws java.io.ObjectStreamException
- Throws:
java.io.ObjectStreamException
-
fromOrdinal
public static InterestResultPolicy fromOrdinal(byte ordinal)
Returns theInterestResultPolicy
represented by specified ordinal- Parameters:
ordinal
- the ordinal representation of anInterestResultPolicy
- Returns:
- the
InterestResultPolicy
represented by specified ordinal
-
getOrdinal
public byte getOrdinal()
Returns the ordinal value.- Returns:
- the ordinal value
- Since:
- GemFire 5.0
-
isNone
public boolean isNone()
Returns true if thisInterestResultPolicy
isNONE
.- Returns:
- true if this
InterestResultPolicy
isNONE
.
-
isKeys
public boolean isKeys()
Returns true if thisInterestResultPolicy
isKEYS
.- Returns:
- true if this
InterestResultPolicy
isKEYS
.
-
isKeysValues
public boolean isKeysValues()
Returns true if thisInterestResultPolicy
isKEYS_VALUES
.- Returns:
- true if this
InterestResultPolicy
isKEYS_VALUES
.
-
isDefault
public boolean isDefault()
Returns true if thisInterestResultPolicy
is the default.- Returns:
- true if this
InterestResultPolicy
is the default.
-
toString
public java.lang.String toString()
Returns a string representation for thisInterestResultPolicy
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- the name of this data policy.
-
-