agi.parallel.infrastructure

Enum CommonResources

java.lang.Object

java.lang.Enum<CommonResources>

agi.parallel.infrastructure.CommonResources

All Implemented Interfaces:

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

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

Common resource values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAILABLE_CORES Number of available cores.
AVAILABLE_HARD_DISK Available hard disk space.
AVAILABLE_MEMORY Available memory.
CURRENT_WORKLOAD Number of tasks currently being run on the agent.
HOSTNAME Hostname of the agent.
IS64BIT_PROCESS Whether agent can run a true 64-bit process.
OS_PLATFORM The OS platform the agent is running on.
TOTAL_CORES Number of CPUs available on the agent.
VERSION The version the agent is running.

Method Summary

Modifier and Type	Method and Description
static CommonResources	getDefault() Get the enum constant that is considered to be the default.
static CommonResources	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
java.lang.String	toString()
static CommonResources	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommonResources[]	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

HOSTNAME

public static final CommonResources HOSTNAME

Hostname of the agent. The resource value will be a string type.

AVAILABLE_CORES

public static final CommonResources AVAILABLE_CORES

Number of available cores. The resource value will an integer type.

AVAILABLE_MEMORY

public static final CommonResources AVAILABLE_MEMORY

Available memory. The unit will be in kilobytes. The resource value will an integer type. The memory unit will be in bytes.

AVAILABLE_HARD_DISK

public static final CommonResources AVAILABLE_HARD_DISK

Available hard disk space. The unit will be in kilobytes. The resource value will an integer type. The hard disk unit will be in bytes.

CURRENT_WORKLOAD

public static final CommonResources CURRENT_WORKLOAD

Number of tasks currently being run on the agent. The resource value will an integer type.

TOTAL_CORES

public static final CommonResources TOTAL_CORES

Number of CPUs available on the agent. The resource value will an integer type.

IS64BIT_PROCESS

public static final CommonResources IS64BIT_PROCESS

Whether agent can run a true 64-bit process. The resource value will a boolean type.

VERSION

public static final CommonResources VERSION

The version the agent is running. The version string will be of the format {majorVersion}.{minorVersion} The resource value will be a string type. The version string will be of the format {majorVersion}.{minorVersion}

OS_PLATFORM

public static final CommonResources OS_PLATFORM

The OS platform the agent is running on. The resource value will a enumeration type.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Returns:

A numeric value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CommonResources>

getFromValue

public static CommonResources getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

public static CommonResources getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.