com.ace.moab.api.node
Enum NodeAccessPolicy

java.lang.Object
  java.lang.Enum<NodeAccessPolicy>
      com.ace.moab.api.node.NodeAccessPolicy

All Implemented Interfaces:

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

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

This enum describes how node resources will be shared by various tasks.

Enum Constant Summary

SHARED
Tasks from any combination of jobs may utilize available resources.

SHAREDONLY
Only jobs requesting shared node access may utilize available resources.

SINGLEJOB
Tasks from a single job may utilize available resourceses.

SINGLETASK
A single task from a single job may run on the node.

SINGLEUSER
Tasks from any jobs owned by the same user may utilize available resources.

UNIQUEUSER
Any number of tasks from a single job may allocate resources from a node but only if the user has no other jobs running on that node.

Method Summary

java.lang.String	getMoabLabel() Returns the label for this access policy used in the moab.cfg and moab.dat
static java.util.List<java.lang.String>	getNames() Returns a collection of all the names of the enum values NodeAccessPolicy type.
static NodeAccessPolicy	parseNodeAccessPolicyString(java.lang.String nodeAccessPolicyString) Parses a string and converts it into a NodeAccessPolicy enum value if possible.
java.lang.String	toString()
static NodeAccessPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NodeAccessPolicy[]	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

SHARED

public static final NodeAccessPolicy SHARED

Tasks from any combination of jobs may utilize available resources.

SHAREDONLY

public static final NodeAccessPolicy SHAREDONLY

Only jobs requesting shared node access may utilize available resources.

SINGLEJOB

public static final NodeAccessPolicy SINGLEJOB

Tasks from a single job may utilize available resourceses.

SINGLETASK

public static final NodeAccessPolicy SINGLETASK

A single task from a single job may run on the node.

SINGLEUSER

public static final NodeAccessPolicy SINGLEUSER

Tasks from any jobs owned by the same user may utilize available resources.

UNIQUEUSER

public static final NodeAccessPolicy UNIQUEUSER

Any number of tasks from a single job may allocate resources from a node but only if the user has no other jobs running on that node.

Method Detail

values

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

Returns:

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

valueOf

public static NodeAccessPolicy 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()

Overrides:

toString in class java.lang.Enum<NodeAccessPolicy>

getMoabLabel

public java.lang.String getMoabLabel()

Returns the label for this access policy used in the moab.cfg and moab.dat

parseNodeAccessPolicyString

public static NodeAccessPolicy parseNodeAccessPolicyString(java.lang.String nodeAccessPolicyString)
                                                    throws java.text.ParseException

Parses a string and converts it into a NodeAccessPolicy enum value if possible.

Parameters:

nodeAccessPolicyString - the string to be parsed.

Returns:

the corresponding NodeAccessPolicy enum value.

Throws:

java.text.ParseException - thrown if the String cannot be parsed.

getNames

public static java.util.List<java.lang.String> getNames()

Returns a collection of all the names of the enum values NodeAccessPolicy type.

Returns:

a collection of all the names of the enum values NodeAccessPolicy type.