org.knime.core.node.workflow

Enum InternalNodeContainerState

java.lang.Object

java.lang.Enum<InternalNodeContainerState>

org.knime.core.node.workflow.InternalNodeContainerState

All Implemented Interfaces:

Serializable, Comparable<InternalNodeContainerState>, NodeContainerState

 enum InternalNodeContainerState
extends Enum<InternalNodeContainerState>
implements NodeContainerState

(Package scope) implementation of NodeContainerState.

Author:

Bernd Wiswedel, Michael Berthold, KNIME.com, Zurich, Switzerland

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURED
CONFIGURED_MARKEDFOREXEC
CONFIGURED_QUEUED
EXECUTED
EXECUTED_MARKEDFOREXEC
EXECUTED_QUEUED
EXECUTING
EXECUTINGREMOTELY
IDLE
POSTEXECUTE
PREEXECUTE
UNCONFIGURED_MARKEDFOREXEC

Method Summary

Modifier and Type	Method and Description
boolean	isConfigured()
boolean	isExecuted()
boolean	isExecutingRemotely()
boolean	isExecutionInProgress()
boolean	isHalted()
boolean	isIdle()
boolean	isWaitingToBeExecuted()
(package private) NodeContainer.State	mapToOldStyleState() Translates this new state to the old style state that got deprecated with 2.8.
static InternalNodeContainerState	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalNodeContainerState[]	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

IDLE

public static final InternalNodeContainerState IDLE

CONFIGURED

public static final InternalNodeContainerState CONFIGURED

UNCONFIGURED_MARKEDFOREXEC

public static final InternalNodeContainerState UNCONFIGURED_MARKEDFOREXEC

CONFIGURED_MARKEDFOREXEC

public static final InternalNodeContainerState CONFIGURED_MARKEDFOREXEC

EXECUTED_MARKEDFOREXEC

public static final InternalNodeContainerState EXECUTED_MARKEDFOREXEC

CONFIGURED_QUEUED

public static final InternalNodeContainerState CONFIGURED_QUEUED

EXECUTED_QUEUED

public static final InternalNodeContainerState EXECUTED_QUEUED

PREEXECUTE

public static final InternalNodeContainerState PREEXECUTE

EXECUTING

public static final InternalNodeContainerState EXECUTING

EXECUTINGREMOTELY

public static final InternalNodeContainerState EXECUTINGREMOTELY

POSTEXECUTE

public static final InternalNodeContainerState POSTEXECUTE

EXECUTED

public static final InternalNodeContainerState EXECUTED

Method Detail

values

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

Returns:

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

valueOf

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

isIdle

public boolean isIdle()

Specified by:

isIdle in interface NodeContainerState

Returns:

true if node is idle (unconfigured, not queued, not marked).

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface NodeContainerState

Returns:

true if node is configured (not queued, not marked).

isExecuted

public boolean isExecuted()

Specified by:

isExecuted in interface NodeContainerState

Returns:

true if node is executed and not marked for re-execution.

isExecutionInProgress

public boolean isExecutionInProgress()

Specified by:

isExecutionInProgress in interface NodeContainerState

Returns:

true if node is executing or waiting to be executed (marked, queued, executing)

isWaitingToBeExecuted

public boolean isWaitingToBeExecuted()

Specified by:

isWaitingToBeExecuted in interface NodeContainerState

Returns:

true if node is waiting to be executed (marked or queued).

isHalted

public boolean isHalted()

Specified by:

isHalted in interface NodeContainerState

Returns:

false if node is executing or queued

isExecutingRemotely

public boolean isExecutingRemotely()

Specified by:

isExecutingRemotely in interface NodeContainerState

Returns:

true if node is currently executing (not queued, not marked but executing) and it's using a non-default job manager. If so (SGE executor), the workflow can be saved without setting it dirty (SGE executor can restore running jobs)

mapToOldStyleState

NodeContainer.State mapToOldStyleState()

Translates this new state to the old style state that got deprecated with 2.8.

Returns:

State

See Also:

NodeContainer.getState()