flux.agent
Enum AgentProcessCompletionState

java.lang.Object
  java.lang.Enum<AgentProcessCompletionState>
      flux.agent.AgentProcessCompletionState

All Implemented Interfaces:

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

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

Indicates how an agent process terminated.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Enum Constant Summary

DESTROYED_DUE_TO_INTERRUPTION
The agent process was destroyed after it was interrupted.

DESTROYED_DUE_TO_SIGNAL
The agent process was destroyed after a signal was received.

DESTROYED_DUE_TO_TIMEOUT
The agent process was destroyed after it timed out.

ERROR
The agent process encountered an error when the execution of the process was attempted.

NORMAL
The agent process finished normally.

TIMEOUT
The agent process timed out but still ran to completion.

Method Summary

static AgentProcessCompletionState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AgentProcessCompletionState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DESTROYED_DUE_TO_INTERRUPTION

public static final AgentProcessCompletionState DESTROYED_DUE_TO_INTERRUPTION

The agent process was destroyed after it was interrupted.

DESTROYED_DUE_TO_SIGNAL

public static final AgentProcessCompletionState DESTROYED_DUE_TO_SIGNAL

The agent process was destroyed after a signal was received.

DESTROYED_DUE_TO_TIMEOUT

public static final AgentProcessCompletionState DESTROYED_DUE_TO_TIMEOUT

The agent process was destroyed after it timed out.

ERROR

public static final AgentProcessCompletionState ERROR

The agent process encountered an error when the execution of the process was attempted.

NORMAL

public static final AgentProcessCompletionState NORMAL

The agent process finished normally.

TIMEOUT

public static final AgentProcessCompletionState TIMEOUT

The agent process timed out but still ran to completion.

Method Detail

values

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

Returns:

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

valueOf

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

java.lang.NullPointerException - if the argument is null