org.ow2.proactive.scheduler.common.job.factories

Enum XMLAttributes

java.lang.Object

java.lang.Enum<XMLAttributes>

org.ow2.proactive.scheduler.common.job.factories.XMLAttributes

All Implemented Interfaces:

Serializable, Comparable<XMLAttributes>

public enum XMLAttributes
extends Enum<XMLAttributes>

XMLAttributes defines attributes allowed in XML job descriptors.

Since:

ProActive Scheduling 2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMON_CANCEL_JOB_ON_ERROR
COMMON_MAX_NUMBER_OF_EXECUTION
COMMON_NAME
COMMON_ON_TASK_ERROR
COMMON_RESTART_TASK_ON_ERROR
COMMON_TASK_RETRY_DELAY
COMMON_VALUE
DS_ACCESS_MODE
DS_EXCLUDES
DS_INCLUDES
DS_URL
FLOW_BLOCK
FLOW_CONTINUATION
FLOW_ELSE
FLOW_TARGET
FORK_JAVA_HOME
JOB_PRIORITY
JOB_PROJECT_NAME
LANGUAGE
PATH
SCRIPT_URL
TASK_CLASS_NAME
TASK_COMMAND_VALUE
TASK_DEPENDS_REF
TASK_FORK
TASK_NB_NODES
TASK_PARAMETER_NAME
TASK_PARAMETER_VALUE
TASK_PRECIOUS_LOGS
TASK_PRECIOUS_RESULT
TASK_RUN_AS_ME
TASK_WALLTIME
TASK_WORKDING_DIR
TOPOLOGY_THRESHOLD
TYPE
VARIABLE_ADVANCED
VARIABLE_DESCRIPTION
VARIABLE_GROUP
VARIABLE_HIDDEN
VARIABLE_JOB_INHERITED
VARIABLE_MODEL
VARIABLE_NAME
VARIABLE_VALUE

Method Summary

Modifier and Type	Method and Description
static XMLAttributes	getFromXMLName(String xmlName) Get the XMLAttributes enum corresponding to the given xml attribute name.
String	getXMLName() Return the XML tag name of the attribute as a String.
boolean	matches(String xmlName) Return true if the given XML name matches this XMLAttributes
String	toString()
static XMLAttributes	valueOf(String name) Returns the enum constant of this type with the specified name.
static XMLAttributes[]	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

JOB_PRIORITY

public static final XMLAttributes JOB_PRIORITY

JOB_PROJECT_NAME

public static final XMLAttributes JOB_PROJECT_NAME

COMMON_CANCEL_JOB_ON_ERROR

public static final XMLAttributes COMMON_CANCEL_JOB_ON_ERROR

COMMON_ON_TASK_ERROR

public static final XMLAttributes COMMON_ON_TASK_ERROR

COMMON_MAX_NUMBER_OF_EXECUTION

public static final XMLAttributes COMMON_MAX_NUMBER_OF_EXECUTION

COMMON_NAME

public static final XMLAttributes COMMON_NAME

COMMON_RESTART_TASK_ON_ERROR

public static final XMLAttributes COMMON_RESTART_TASK_ON_ERROR

COMMON_TASK_RETRY_DELAY

public static final XMLAttributes COMMON_TASK_RETRY_DELAY

COMMON_VALUE

public static final XMLAttributes COMMON_VALUE

VARIABLE_NAME

public static final XMLAttributes VARIABLE_NAME

VARIABLE_VALUE

public static final XMLAttributes VARIABLE_VALUE

VARIABLE_MODEL

public static final XMLAttributes VARIABLE_MODEL

VARIABLE_JOB_INHERITED

public static final XMLAttributes VARIABLE_JOB_INHERITED

VARIABLE_DESCRIPTION

public static final XMLAttributes VARIABLE_DESCRIPTION

VARIABLE_GROUP

public static final XMLAttributes VARIABLE_GROUP

VARIABLE_ADVANCED

public static final XMLAttributes VARIABLE_ADVANCED

VARIABLE_HIDDEN

public static final XMLAttributes VARIABLE_HIDDEN

TASK_CLASS_NAME

public static final XMLAttributes TASK_CLASS_NAME

TASK_DEPENDS_REF

public static final XMLAttributes TASK_DEPENDS_REF

TASK_PRECIOUS_LOGS

public static final XMLAttributes TASK_PRECIOUS_LOGS

TASK_PRECIOUS_RESULT

public static final XMLAttributes TASK_PRECIOUS_RESULT

TASK_RUN_AS_ME

public static final XMLAttributes TASK_RUN_AS_ME

TASK_FORK

public static final XMLAttributes TASK_FORK

TASK_WALLTIME

public static final XMLAttributes TASK_WALLTIME

TASK_COMMAND_VALUE

public static final XMLAttributes TASK_COMMAND_VALUE

TASK_NB_NODES

public static final XMLAttributes TASK_NB_NODES

TASK_PARAMETER_NAME

public static final XMLAttributes TASK_PARAMETER_NAME

TASK_PARAMETER_VALUE

public static final XMLAttributes TASK_PARAMETER_VALUE

TASK_WORKDING_DIR

public static final XMLAttributes TASK_WORKDING_DIR

TOPOLOGY_THRESHOLD

public static final XMLAttributes TOPOLOGY_THRESHOLD

SCRIPT_URL

public static final XMLAttributes SCRIPT_URL

FORK_JAVA_HOME

public static final XMLAttributes FORK_JAVA_HOME

FLOW_BLOCK

public static final XMLAttributes FLOW_BLOCK

FLOW_CONTINUATION

public static final XMLAttributes FLOW_CONTINUATION

FLOW_ELSE

public static final XMLAttributes FLOW_ELSE

FLOW_TARGET

public static final XMLAttributes FLOW_TARGET

DS_ACCESS_MODE

public static final XMLAttributes DS_ACCESS_MODE

DS_EXCLUDES

public static final XMLAttributes DS_EXCLUDES

DS_INCLUDES

public static final XMLAttributes DS_INCLUDES

DS_URL

public static final XMLAttributes DS_URL

PATH

public static final XMLAttributes PATH

LANGUAGE

public static final XMLAttributes LANGUAGE

TYPE

public static final XMLAttributes TYPE

Method Detail

values

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

Returns:

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

valueOf

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

getXMLName

public String getXMLName()

Return the XML tag name of the attribute as a String.

Returns:

the XML tag name of the attribute as a String.

getFromXMLName

public static XMLAttributes getFromXMLName(String xmlName)

Get the XMLAttributes enum corresponding to the given xml attribute name. This method ignores the case.

Parameters:

xmlName - the XML attribute name as a string

Returns:

the corresponding XML attribute.

Throws:

IllegalArgumentException - if the attribute name does not exist

matches

public boolean matches(String xmlName)

Return true if the given XML name matches this XMLAttributes

Parameters:

xmlName - the XML attribute name as a String.

Returns:

true only if the given XML name matches this XMLAttributes

toString

public String toString()

Overrides:

toString in class Enum<XMLAttributes>