org.apache.nifi.components.state

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.apache.nifi.components.state.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

A Scope represents how a NiFi component's state is to be stored and retrieved when running in a cluster.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLUSTER State is to be treated as "global" across the cluster.
LOCAL State is to be treated local to the node.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLUSTER

public static final Scope CLUSTER

State is to be treated as "global" across the cluster. I.e., the same component on all nodes will have access to the same state.

LOCAL

public static final Scope LOCAL

State is to be treated local to the node. I.e., the same component will have different state on each node in the cluster.

Method Detail

values

public static 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 (Scope c : 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 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

toString

public String toString()

Overrides:

toString in class Enum<Scope>