Package org.cip4.jdflib.core
Class JDFElement.EnumNodeStatus
- java.lang.Object
-
- org.apache.commons.lang.enums.Enum
-
- org.apache.commons.lang.enums.ValuedEnum
-
- org.cip4.jdflib.core.JDFElement.EnumNodeStatus
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable
- Enclosing class:
- JDFElement
public static final class JDFElement.EnumNodeStatus extends org.apache.commons.lang.enums.ValuedEnumEnumeration of valid nodestatus types Identifies the status of the node. Possible values are:- Waiting - The node may be executed, but it has not completed a test run.
- TestRunInProgress - The node is currently executing a test run.
- Ready - As indicated by the successful completion of a test run, all ResourceLinks are correct, required resources are available, and the parameters of resources are valid. The node is ready to start.
- FailedTestRun - An error occurred during the test run. Error information is logged in the Notification element, which is an optional subelement of the AuditPool element described in Section 3.9, AuditPool.
- Setup - The process represented by this node is currently being set up.
- InProgress - The node is currently executing.
- Cleanup - The process represented by this node is currently being cleaned up.
- Spawned - The node is spawned in the form of a separate spawned JDF. The status Spawned can only be assigned to the original instance of the spawned job. For details, see Section 4.4, Spawning and Merging.
- Stopped - Execution has been stopped. If a job is Stopped, running may be resumed later. This status may indicate a break, a pause, maintenance, or a breakdown - in short, any pause that does not lead the job to be aborted.
- Completed - Indicates that the node has been executed correctly, and is finished.
- Aborted - Indicates that the process executing the node has been aborted, which means that execution will not be resumed again.
- Pool - Indicates that the node processes partitioned resources and that the Status varies depending on the partition keys. Details are provided in the StatusPool
element of the node.
Derivation of the Status of a parent node from the Status of child nodes is non-trivial and implementation-dependent
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static JDFElement.EnumNodeStatusAbortedstatic JDFElement.EnumNodeStatusCleanupstatic JDFElement.EnumNodeStatusCompletedstatic JDFElement.EnumNodeStatusFailedTestRunstatic JDFElement.EnumNodeStatusInProgressstatic JDFElement.EnumNodeStatusPartstatic JDFElement.EnumNodeStatusPoolstatic JDFElement.EnumNodeStatusReadystatic JDFElement.EnumNodeStatusSetupstatic JDFElement.EnumNodeStatusSpawnedstatic JDFElement.EnumNodeStatusStoppedstatic JDFElement.EnumNodeStatusSuspendedstatic JDFElement.EnumNodeStatusTestRunInProgressstatic JDFElement.EnumNodeStatusWaiting
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static JDFAutoDeviceInfo.EnumDeviceStatusgetDeviceStatus(JDFElement.EnumNodeStatus ns)returns the queuentrystatus corresponding to a node statusstatic JDFElement.EnumNodeStatusgetEnum(int enumValue)static JDFElement.EnumNodeStatusgetEnum(java.lang.String enumName)static java.util.ListgetEnumList()static java.util.MapgetEnumMap()static JDFElement.EnumNodeStatusgetNodeStatus(JDFAutoQueueEntry.EnumQueueEntryStatus qes)returns the node status corresponding to a queueEntry statusstatic JDFAutoQueueEntry.EnumQueueEntryStatusgetQueueEntryStatus(JDFElement.EnumNodeStatus ns)returns the queuentrystatus corresponding to a node statusstatic booleanisCompleted(JDFElement.EnumNodeStatus nodeStatus)returns true if we are in an end phase (Completed or Aborted)static java.util.Iteratoriterator()-
Methods inherited from class org.apache.commons.lang.enums.ValuedEnum
compareTo, getEnum, getValue, toString
-
-
-
-
Field Detail
-
Waiting
public static final JDFElement.EnumNodeStatus Waiting
-
TestRunInProgress
public static final JDFElement.EnumNodeStatus TestRunInProgress
-
Ready
public static final JDFElement.EnumNodeStatus Ready
-
FailedTestRun
public static final JDFElement.EnumNodeStatus FailedTestRun
-
Setup
public static final JDFElement.EnumNodeStatus Setup
-
InProgress
public static final JDFElement.EnumNodeStatus InProgress
-
Cleanup
public static final JDFElement.EnumNodeStatus Cleanup
-
Spawned
public static final JDFElement.EnumNodeStatus Spawned
-
Suspended
public static final JDFElement.EnumNodeStatus Suspended
-
Stopped
public static final JDFElement.EnumNodeStatus Stopped
-
Completed
public static final JDFElement.EnumNodeStatus Completed
-
Aborted
public static final JDFElement.EnumNodeStatus Aborted
-
Part
public static final JDFElement.EnumNodeStatus Part
-
Pool
public static final JDFElement.EnumNodeStatus Pool
-
-
Method Detail
-
getEnum
public static JDFElement.EnumNodeStatus getEnum(java.lang.String enumName)
- Parameters:
enumName- the name of the enum object to return- Returns:
- the enum object if enumName is valid. Otherwise null
-
getEnum
public static JDFElement.EnumNodeStatus getEnum(int enumValue)
- Parameters:
enumValue- the value of the enum object to return- Returns:
- the enum object if enumName is valid. Otherwise null
-
getEnumMap
public static java.util.Map getEnumMap()
- Returns:
- a map of all orientation enums
-
getEnumList
public static java.util.List getEnumList()
- Returns:
- a list of all orientation enums
-
getQueueEntryStatus
public static JDFAutoQueueEntry.EnumQueueEntryStatus getQueueEntryStatus(JDFElement.EnumNodeStatus ns)
returns the queuentrystatus corresponding to a node status- Parameters:
ns- the node status to test agains- Returns:
- the queentrystatus that corresponds to ns; may be null in case of pool or part
-
getDeviceStatus
public static JDFAutoDeviceInfo.EnumDeviceStatus getDeviceStatus(JDFElement.EnumNodeStatus ns)
returns the queuentrystatus corresponding to a node status- Parameters:
ns- the node status to test agains- Returns:
- the queentrystatus that corresponds to ns; may be null in case of pool or part
-
getNodeStatus
public static JDFElement.EnumNodeStatus getNodeStatus(JDFAutoQueueEntry.EnumQueueEntryStatus qes)
returns the node status corresponding to a queueEntry status- Parameters:
qes- the queueEntry status to test agains- Returns:
- the node status that corresponds to qes;
-
iterator
public static java.util.Iterator iterator()
- Returns:
- an iterator over the enum objects
-
isCompleted
public static boolean isCompleted(JDFElement.EnumNodeStatus nodeStatus)
returns true if we are in an end phase (Completed or Aborted)- Parameters:
nodeStatus- the status to compare- Returns:
- true if we are in an end phase (Completed or Aborted)
-
-