org.knime.core.node.workflow
Enum FlowVariable.Scope

java.lang.Object
  java.lang.Enum<FlowVariable.Scope>
      org.knime.core.node.workflow.FlowVariable.Scope

All Implemented Interfaces:

Serializable, Comparable<FlowVariable.Scope>

Enclosing class:

FlowVariable

public static enum FlowVariable.Scope
extends Enum<FlowVariable.Scope>

Scope of variable.

Enum Constant Summary

Flow
Ordinary workflow or flow variable.

Global
(VM-)Global constant, such as workspace location.

Local
Node local flow variable, e.g.

Method Summary

String	getPrefix()
static FlowVariable.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static FlowVariable.Scope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	verifyName(String name) Throws IllegalFlowObjectStackException if the name of the variable is inconsistent for this scope.

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

Global

public static final FlowVariable.Scope Global

(VM-)Global constant, such as workspace location.

Flow

public static final FlowVariable.Scope Flow

Ordinary workflow or flow variable.

Local

public static final FlowVariable.Scope Local

Node local flow variable, e.g. node drop location.

Method Detail

values

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

Returns:

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

valueOf

public static FlowVariable.Scope 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

getPrefix

public String getPrefix()

Returns:

the prefix

verifyName

public void verifyName(String name)

Throws IllegalFlowObjectStackException if the name of the variable is inconsistent for this scope.

Parameters:

name - Name to test

Throws:

IllegalFlowObjectStackException - If name is invalid