com.gemstone.gemfire.internal.shared

Enum FetchRequest

java.lang.Object

java.lang.Enum<FetchRequest>

com.gemstone.gemfire.internal.shared.FetchRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FetchRequest>

public enum FetchRequest
extends java.lang.Enum<FetchRequest>

Request sent to ByteBufferReference.getValueRetain(com.gemstone.gemfire.internal.shared.FetchRequest).

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPRESS Return compressed buffer and store in region if required.
DECOMPRESS Return decompressed buffer and store in region if possible.
DECOMPRESS_IF_IN_MEMORY Return decompressed buffer only if decompressed form can be stored in memory (i.e.
ORIGINAL Return with original form of buffer.

Method Summary

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

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

Enum Constant Detail

ORIGINAL

public static final FetchRequest ORIGINAL

Return with original form of buffer.

DECOMPRESS

public static final FetchRequest DECOMPRESS

Return decompressed buffer and store in region if possible.

COMPRESS

public static final FetchRequest COMPRESS

Return compressed buffer and store in region if required.

DECOMPRESS_IF_IN_MEMORY

public static final FetchRequest DECOMPRESS_IF_IN_MEMORY

Return decompressed buffer only if decompressed form can be stored in memory (i.e. don't expend effort to decompress multiple times for every fetch) else return null if need to read from disk. Typically must be followed by a call with ORIGINAL in case result is null.

Method Detail

values

public static FetchRequest[] 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 (FetchRequest c : FetchRequest.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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