Package org.apache.nifi.controller

Enum Class ScheduledState

java.lang.Object

java.lang.Enum<ScheduledState>

org.apache.nifi.controller.ScheduledState

All Implemented Interfaces:

Serializable, Comparable<ScheduledState>, Constable

public enum ScheduledState
extends Enum<ScheduledState>

Indicates the valid values for the state of a Triggerable entity with respect to scheduling the entity to run.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Entity cannot be scheduled to run
RUN_ONCE
RUNNING	Entity is currently scheduled to run
STARTING
STOPPED	Entity can be scheduled to run but currently is not
STOPPING

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ScheduledState()

Method Summary

Modifier and Type	Method	Description
static ScheduledState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScheduledState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final ScheduledState DISABLED

Entity cannot be scheduled to run

STOPPED

public static final ScheduledState STOPPED

Entity can be scheduled to run but currently is not

RUNNING

public static final ScheduledState RUNNING

Entity is currently scheduled to run

STARTING

public static final ScheduledState STARTING

STOPPING

public static final ScheduledState STOPPING

RUN_ONCE

public static final ScheduledState RUN_ONCE

Constructor Details

ScheduledState

private ScheduledState()

Method Details

values

public static ScheduledState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ScheduledState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null