com.ace.moab.api.vm
Enum VMUsagePolicy

java.lang.Object
  java.lang.Enum<VMUsagePolicy>
      com.ace.moab.api.vm.VMUsagePolicy

All Implemented Interfaces:

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

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

Describes the virtual machine requirements of a job

Enum Constant Summary

CREATEVM
Creates a virtual machine

PREFPM
Prefers a physical machine

PREFVM
Prefers a virtual machine

REQUIREPM
Requires a physical machine

REQUIREVM
Requires a virtual machine

Method Summary

java.lang.String	getMoabLabel() Returns the representation of this VMUsagePolicy used when communicating with Moab Workload Manager
static VMUsagePolicy	parse(java.lang.String vmUsagePolString) Returns the VMUsagePolicy represented by the passed in String.
java.lang.String	toString() Returns a String representation of this VMUsagePolicy
static VMUsagePolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VMUsagePolicy[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUIREPM

public static final VMUsagePolicy REQUIREPM

Requires a physical machine

PREFPM

public static final VMUsagePolicy PREFPM

Prefers a physical machine

CREATEVM

public static final VMUsagePolicy CREATEVM

Creates a virtual machine

REQUIREVM

public static final VMUsagePolicy REQUIREVM

Requires a virtual machine

PREFVM

public static final VMUsagePolicy PREFVM

Prefers a virtual machine

Method Detail

values

public static final VMUsagePolicy[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(VMUsagePolicy c : VMUsagePolicy.values())
        System.out.println(c);

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Returns a String representation of this VMUsagePolicy

Overrides:

toString in class java.lang.Enum<VMUsagePolicy>

getMoabLabel

public java.lang.String getMoabLabel()

Returns the representation of this VMUsagePolicy used when communicating with Moab Workload Manager

Returns:

the representation of this VMUsagePolicy used when communicating with Moab Workload Manager

parse

public static VMUsagePolicy parse(java.lang.String vmUsagePolString)

Returns the VMUsagePolicy represented by the passed in String. If no VMUsagePolicy matches, null will be returned.

Parameters:

vmUsagePolString - a String that represents a VMUsagePolicy

Returns:

the VMUsagePolicy