org.apache.arrow.memory

Enum AllocationOutcome

java.lang.Object

java.lang.Enum<AllocationOutcome>

org.apache.arrow.memory.AllocationOutcome

All Implemented Interfaces:

Serializable, Comparable<AllocationOutcome>

public enum AllocationOutcome
extends Enum<AllocationOutcome>

Describes the type of outcome that occurred when trying to account for allocation of memory.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED_LOCAL Allocation failed because the local allocator's limits were exceeded.
FAILED_PARENT Allocation failed because a parent allocator's limits were exceeded.
FORCED_SUCCESS Allocation succeeded but only because the allocator was forced to move beyond a limit.
SUCCESS Allocation succeeded.

Method Summary

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

SUCCESS

public static final AllocationOutcome SUCCESS

Allocation succeeded.

FORCED_SUCCESS

public static final AllocationOutcome FORCED_SUCCESS

Allocation succeeded but only because the allocator was forced to move beyond a limit.

FAILED_LOCAL

public static final AllocationOutcome FAILED_LOCAL

Allocation failed because the local allocator's limits were exceeded.

FAILED_PARENT

public static final AllocationOutcome FAILED_PARENT

Allocation failed because a parent allocator's limits were exceeded.

Method Detail

values

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

Returns:

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

valueOf

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

isOk

public boolean isOk()