org.apache.taverna.workflowmodel.processor.dispatch.description

Enum DispatchMessageType

java.lang.Object

java.lang.Enum<DispatchMessageType>

org.apache.taverna.workflowmodel.processor.dispatch.description.DispatchMessageType

All Implemented Interfaces:

Serializable, Comparable<DispatchMessageType>

public enum DispatchMessageType
extends Enum<DispatchMessageType>

Enumeration of the possible message types passed between layers of the dispatch stack.

Author:

Tom Oinn

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR A failure message sent by the layer below to denote some kind of failure (surprisingly)
JOB A Job object and list of activities to be used to process the data in the Job.
JOB_QUEUE A reference to a queue of Job objects waiting to be used as input along with a list of activities to process them.
RESULT A Job object containing the result of a single activity invocation.
RESULT_COMPLETION A (possibly partial) completion event from the layer below.

Method Summary

Modifier and Type	Method and Description
static DispatchMessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DispatchMessageType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JOB_QUEUE

public static final DispatchMessageType JOB_QUEUE

A reference to a queue of Job objects waiting to be used as input along with a list of activities to process them.

JOB

public static final DispatchMessageType JOB

A Job object and list of activities to be used to process the data in the Job. The Job will have been previously extracted from the JobQueue

RESULT

public static final DispatchMessageType RESULT

A Job object containing the result of a single activity invocation.

RESULT_COMPLETION

public static final DispatchMessageType RESULT_COMPLETION

A (possibly partial) completion event from the layer below. This is only going to be used when the activity invocation is capable of streaming partial data back up through the dispatch stack before the activity has completed. Not all dispatch stack layers are compatible with this mode of operation, for example retry and recursion do not play well here!

ERROR

public static final DispatchMessageType ERROR

A failure message sent by the layer below to denote some kind of failure (surprisingly)

Method Detail

values

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

Returns:

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

valueOf

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