com.azul.zing.management

Enum MemoryPoolSizeType

java.lang.Object

java.lang.Enum<MemoryPoolSizeType>

com.azul.zing.management.MemoryPoolSizeType

All Implemented Interfaces:

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

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

MemoryPoolSizeType describes a memory pool’s ability to shrink and/or grow dynamically according to need. ELASTIC memory pools have the ability to use unused memory that other memory pools are not using. Likewise, when the memory pool no longer needs to use all of its memory, it can return that memory so that it can be used by other sibling memory pools.

ELASTIC memory behaves much differently than FIXED memory. The latter has a fixed upper bound on its size, usually set when the memory for that memory pool is initially reserved.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ELASTIC Dynamic size memory region size type.
FIXED Fixed size memory region size type.
UNINITIALIZED Unitialized memory pool size type.

Method Summary

Methods

Modifier and Type	Method and Description
static MemoryPoolSizeType	enumValue(long ordinalValue) Returns the MemoryPoolSizeType enum value corresponding to a long value.
static MemoryPoolSizeType	enumValue(java.lang.String stringValue) Returns the MemoryPoolSizeType enum value corresponding to a String value.
static int	numberOfElements() Returns the number of enum values in MemoryPoolSizeType.
java.lang.String	toString() Returns the string representation of this MemoryPoolSizeType.
static MemoryPoolSizeType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MemoryPoolSizeType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ELASTIC

public static final MemoryPoolSizeType ELASTIC

Dynamic size memory region size type.

The amount of memory reserved for the region by the Java virtual machine can vary over time, increasing or decreasing.

FIXED

public static final MemoryPoolSizeType FIXED

Fixed size memory region size type.

The Java virtual machine reserves a fixed size amount of memory for the region.

UNINITIALIZED

public static final MemoryPoolSizeType UNINITIALIZED

Unitialized memory pool size type.

There are two reasons that a MemoryUsage might be labeled UNINITIALIZED:

1. The memory region itself has not been reserved, so there is nothing to report; or
2. The query for the MemoryUsage has occurred before a condition for initialization of the MemoryUsage object has occurred. For example, before a garbage collection occurs, a MemoryUsage object returned from getMemoryUseAtEndOfGC() will not have been initialized.

Method Detail

enumValue

public static MemoryPoolSizeType enumValue(long ordinalValue)

Returns the MemoryPoolSizeType enum value corresponding to a long value.

Parameters:

ordinalValue - value corresponding to a MemoryPoolSizeType enum value’s ordinal value.

Returns:

the MemoryPoolSizeType enum value corresponding to a long value.

Throws:

java.lang.IllegalArgumentException - if ordinalValue is less than 0 or ordinalValue is greater than the value returned by #numberOfElements().

enumValue

public static MemoryPoolSizeType enumValue(java.lang.String stringValue)

Returns the MemoryPoolSizeType enum value corresponding to a String value.

Parameters:

stringValue - value corresponding to a MemoryPoolSizeType enum value’s String value.

Returns:

the MemoryPoolSizeType enum value corresponding to a String value.

Throws:

java.lang.IllegalArgumentException - if stringValue does not match one of the enum values.

numberOfElements

public static int numberOfElements()

Returns the number of enum values in MemoryPoolSizeType.

Returns:

the number of enum values in MemoryPoolSizeType.

toString

public java.lang.String toString()

Returns the string representation of this MemoryPoolSizeType.

Overrides:

toString in class java.lang.Enum<MemoryPoolSizeType>

Returns:

the string representation of this MemoryPoolSizeType.

valueOf

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

values

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

Returns:

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