Package org.apache.ignite.cache
Enum CachePeekMode
- java.lang.Object
-
- java.lang.Enum<CachePeekMode>
-
- org.apache.ignite.cache.CachePeekMode
-
- All Implemented Interfaces:
Serializable,Comparable<CachePeekMode>
public enum CachePeekMode extends Enum<CachePeekMode>
Enumeration of all supported cache peek modes. Peek modes can be passed intoIgniteCache.localPeek(Object, CachePeekMode...),IgniteCache.localEntries(CachePeekMode...),IgniteCache.localSize(CachePeekMode...)andIgniteCache.size(CachePeekMode...)methods.The following modes are supported:
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALLPeeks into all available cache storages.BACKUPPeek value from backup copies of partitioned cache only (skip near cache).NEARPeek into near cache only (don't peek into partitioned cache).OFFHEAPPeeks value from the off-heap storage only, without loading off-heap value into cache.ONHEAPPeeks value from the on-heap storage only.PRIMARYPeek value from primary copy of partitioned cache only (skip near cache).
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static @Nullable CachePeekModefromOrdinal(byte ord)Efficiently gets enumerated value from its ordinal.static CachePeekModevalueOf(String name)Returns the enum constant of this type with the specified name.static CachePeekMode[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ALL
public static final CachePeekMode ALL
Peeks into all available cache storages.
-
NEAR
public static final CachePeekMode NEAR
Peek into near cache only (don't peek into partitioned cache).
-
PRIMARY
public static final CachePeekMode PRIMARY
Peek value from primary copy of partitioned cache only (skip near cache).
-
BACKUP
public static final CachePeekMode BACKUP
Peek value from backup copies of partitioned cache only (skip near cache).
-
ONHEAP
public static final CachePeekMode ONHEAP
Peeks value from the on-heap storage only.
-
OFFHEAP
public static final CachePeekMode OFFHEAP
Peeks value from the off-heap storage only, without loading off-heap value into cache.
-
-
Method Detail
-
values
public static CachePeekMode[] 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 (CachePeekMode c : CachePeekMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CachePeekMode valueOf(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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromOrdinal
@Nullable public static @Nullable CachePeekMode fromOrdinal(byte ord)
Efficiently gets enumerated value from its ordinal.- Parameters:
ord- Ordinal value.- Returns:
- Enumerated value or
nullif ordinal out of range.
-
-