org.apache.flink.core.memory

Enum MemoryType

java.lang.Object

java.lang.Enum<MemoryType>

org.apache.flink.core.memory.MemoryType

All Implemented Interfaces:

Serializable, Comparable<MemoryType>

@Internal
public enum MemoryType
extends Enum<MemoryType>

The class of memory, such as heap or off-heap.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEAP Denotes memory that is part of the Java heap.
OFF_HEAP Denotes memory that is outside the Java heap (but still part of tha Java process).

Method Summary

Modifier and Type	Method and Description
static MemoryType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MemoryType[]	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

HEAP

public static final MemoryType HEAP

Denotes memory that is part of the Java heap.

OFF_HEAP

public static final MemoryType OFF_HEAP

Denotes memory that is outside the Java heap (but still part of tha Java process).

Method Detail

values

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

Returns:

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

valueOf

public static MemoryType 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 name

NullPointerException - if the argument is null