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

Enum XMLTags

java.lang.Object

java.lang.Enum<XMLTags>

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

All Implemented Interfaces:

Serializable, Comparable<XMLTags>

public enum XMLTags
extends Enum<XMLTags>

XMLTags defines all tags that can be used in an XML job descriptor.

Since:

ProActive Scheduling 2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMON_DESCRIPTION
COMMON_GENERIC_INFORMATION
COMMON_INFO
DS_FILES
DS_GLOBAL_SPACE
DS_INPUT_FILES
DS_INPUT_SPACE
DS_OUTPUT_FILES
DS_OUTPUT_SPACE
DS_USER_SPACE
FLOW
FLOW_IF
FLOW_LOOP
FLOW_REPLICATE
FORK_ADDITIONAL_CLASSPATH
FORK_ENVIRONMENT
FORK_JVM_ARG
FORK_JVM_ARGS
FORK_PATH_ELEMENT
FORK_SYSTEM_PROPERTIES
FORK_SYSTEM_PROPERTY
JAVA_EXECUTABLE
JOB
JOB_CLASSPATHES
JOB_PATH_ELEMENT
METADATA
METADATA_VISUALIZATION
NATIVE_EXECUTABLE
NATIVE_TASK_ARGUMENT
NATIVE_TASK_ARGUMENTS
NATIVE_TASK_STATIC_COMMAND
PARALLEL_ENV
SCRIPT_ARGUMENT
SCRIPT_ARGUMENTS
SCRIPT_CLEANING
SCRIPT_CODE
SCRIPT_ENV
SCRIPT_EXECUTABLE
SCRIPT_FILE
SCRIPT_POST
SCRIPT_PRE
SCRIPT_SCRIPT
SCRIPT_SELECTION
TASK
TASK_DEPENDENCES
TASK_DEPENDENCES_TASK
TASK_FLOW
TASK_PARAMETER
TASK_PARAMETERS
TOPOLOGY
TOPOLOGY_ARBITRARY
TOPOLOGY_BEST_PROXIMITY
TOPOLOGY_DIFFERENT_HOSTS_EXCLUSIVE
TOPOLOGY_MULTIPLE_HOSTS_EXCLUSIVE
TOPOLOGY_SINGLE_HOST
TOPOLOGY_SINGLE_HOST_EXCLUSIVE
TOPOLOGY_THRESHOLD_PROXIMITY
VARIABLE
VARIABLES

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_TAG_PATTERN pattern that matches for open tag for provided tag name.
static String	OPEN_TAG_PATTERN pattern that matches for open tag for provided tag name.

Method Summary

Modifier and Type	Method and Description
String	getCloseTagPattern()
static XMLTags	getFromXMLName(String xmlName) Get the XMLTags enum corresponding to the given xml tag name.
String	getOpenTagPattern()
String	getXMLName() Return the XML tag name of the element as a String.
boolean	matches(String xmlName) Return true if the given XML name matches this XMLAttributes
String	toString()
static XMLTags	valueOf(String name) Returns the enum constant of this type with the specified name.
static XMLTags[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
String	withContent(String content)

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

public static final XMLTags JOB

JOB_CLASSPATHES

public static final XMLTags JOB_CLASSPATHES

JOB_PATH_ELEMENT

public static final XMLTags JOB_PATH_ELEMENT

TASK_FLOW

public static final XMLTags TASK_FLOW

COMMON_DESCRIPTION

public static final XMLTags COMMON_DESCRIPTION

COMMON_GENERIC_INFORMATION

public static final XMLTags COMMON_GENERIC_INFORMATION

COMMON_INFO

public static final XMLTags COMMON_INFO

VARIABLE

public static final XMLTags VARIABLE

VARIABLES

public static final XMLTags VARIABLES

JAVA_EXECUTABLE

public static final XMLTags JAVA_EXECUTABLE

NATIVE_EXECUTABLE

public static final XMLTags NATIVE_EXECUTABLE

NATIVE_TASK_ARGUMENT

public static final XMLTags NATIVE_TASK_ARGUMENT

NATIVE_TASK_ARGUMENTS

public static final XMLTags NATIVE_TASK_ARGUMENTS

NATIVE_TASK_STATIC_COMMAND

public static final XMLTags NATIVE_TASK_STATIC_COMMAND

SCRIPT_EXECUTABLE

public static final XMLTags SCRIPT_EXECUTABLE

TASK

public static final XMLTags TASK

TASK_DEPENDENCES

public static final XMLTags TASK_DEPENDENCES

TASK_DEPENDENCES_TASK

public static final XMLTags TASK_DEPENDENCES_TASK

TASK_PARAMETER

public static final XMLTags TASK_PARAMETER

TASK_PARAMETERS

public static final XMLTags TASK_PARAMETERS

PARALLEL_ENV

public static final XMLTags PARALLEL_ENV

TOPOLOGY

public static final XMLTags TOPOLOGY

TOPOLOGY_ARBITRARY

public static final XMLTags TOPOLOGY_ARBITRARY

TOPOLOGY_BEST_PROXIMITY

public static final XMLTags TOPOLOGY_BEST_PROXIMITY

TOPOLOGY_DIFFERENT_HOSTS_EXCLUSIVE

public static final XMLTags TOPOLOGY_DIFFERENT_HOSTS_EXCLUSIVE

TOPOLOGY_MULTIPLE_HOSTS_EXCLUSIVE

public static final XMLTags TOPOLOGY_MULTIPLE_HOSTS_EXCLUSIVE

TOPOLOGY_SINGLE_HOST

public static final XMLTags TOPOLOGY_SINGLE_HOST

TOPOLOGY_SINGLE_HOST_EXCLUSIVE

public static final XMLTags TOPOLOGY_SINGLE_HOST_EXCLUSIVE

TOPOLOGY_THRESHOLD_PROXIMITY

public static final XMLTags TOPOLOGY_THRESHOLD_PROXIMITY

SCRIPT_ARGUMENT

public static final XMLTags SCRIPT_ARGUMENT

SCRIPT_ARGUMENTS

public static final XMLTags SCRIPT_ARGUMENTS

SCRIPT_CLEANING

public static final XMLTags SCRIPT_CLEANING

SCRIPT_CODE

public static final XMLTags SCRIPT_CODE

SCRIPT_FILE

public static final XMLTags SCRIPT_FILE

SCRIPT_PRE

public static final XMLTags SCRIPT_PRE

SCRIPT_POST

public static final XMLTags SCRIPT_POST

SCRIPT_SCRIPT

public static final XMLTags SCRIPT_SCRIPT

SCRIPT_SELECTION

public static final XMLTags SCRIPT_SELECTION

FORK_ADDITIONAL_CLASSPATH

public static final XMLTags FORK_ADDITIONAL_CLASSPATH

FORK_ENVIRONMENT

public static final XMLTags FORK_ENVIRONMENT

FORK_JVM_ARG

public static final XMLTags FORK_JVM_ARG

FORK_JVM_ARGS

public static final XMLTags FORK_JVM_ARGS

FORK_PATH_ELEMENT

public static final XMLTags FORK_PATH_ELEMENT

FORK_SYSTEM_PROPERTIES

public static final XMLTags FORK_SYSTEM_PROPERTIES

FORK_SYSTEM_PROPERTY

public static final XMLTags FORK_SYSTEM_PROPERTY

SCRIPT_ENV

public static final XMLTags SCRIPT_ENV

FLOW

public static final XMLTags FLOW

FLOW_IF

public static final XMLTags FLOW_IF

FLOW_LOOP

public static final XMLTags FLOW_LOOP

FLOW_REPLICATE

public static final XMLTags FLOW_REPLICATE

DS_FILES

public static final XMLTags DS_FILES

DS_GLOBAL_SPACE

public static final XMLTags DS_GLOBAL_SPACE

DS_INPUT_FILES

public static final XMLTags DS_INPUT_FILES

DS_INPUT_SPACE

public static final XMLTags DS_INPUT_SPACE

DS_OUTPUT_FILES

public static final XMLTags DS_OUTPUT_FILES

DS_OUTPUT_SPACE

public static final XMLTags DS_OUTPUT_SPACE

DS_USER_SPACE

public static final XMLTags DS_USER_SPACE

METADATA

public static final XMLTags METADATA

METADATA_VISUALIZATION

public static final XMLTags METADATA_VISUALIZATION

Field Detail

OPEN_TAG_PATTERN

public static final String OPEN_TAG_PATTERN

pattern that matches for open tag for provided tag name. e.g.: String.format(OPEN_TAG_PATTERN, XMLTags.VARIABLES seeks for the string like this: <variables>, < variables>, <variables >, etc.

See Also:

Constant Field Values

CLOSE_TAG_PATTERN

public static final String CLOSE_TAG_PATTERN

pattern that matches for open tag for provided tag name. e.g.: String.format(CLOSE_TAG_PATTERN, XMLTags.VARIABLES seeks for the string like this: </variables>, <variables/> </ variables>, < / variables >, etc.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static XMLTags 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 element as a String.

Returns:

the XML tag name of the element as a String.

getOpenTagPattern

public String getOpenTagPattern()

getCloseTagPattern

public String getCloseTagPattern()

getFromXMLName

public static XMLTags getFromXMLName(String xmlName)

Get the XMLTags enum corresponding to the given xml tag name. This method ignores the case. Argument cannot be null.

Parameters:

xmlName - the XML tag name as a string.

Returns:

the corresponding XML tag.

Throws:

IllegalArgumentException - if the tag name does not exist.

matches

public boolean matches(String xmlName)

Return true if the given XML name matches this XMLAttributes

Parameters:

xmlName - the XML tag name as a String.

Returns:

true only if the given XML name matches this XMLTags

withContent

public String withContent(String content)

toString

public String toString()

Overrides:

toString in class Enum<XMLTags>