Package com.inductiveautomation.eventstream

Enum Class EventStreamState

java.lang.Object

java.lang.Enum<EventStreamState>

com.inductiveautomation.eventstream.EventStreamState

All Implemented Interfaces:

Serializable, Comparable<EventStreamState>, Constable

public enum EventStreamState
extends Enum<EventStreamState>

Represents the current state an Event Stream

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	Event Stream is disabled.
FAULTED	One or more stages are faulted.
INACTIVE	Event Stream was started, but Gateway is inactive.
RUNNING	Event Stream successfully started, source will be subscribed and receiving events.
STARTING_UP	Event Stream is starting up.
STOPPED	Event Stream hasn't been started yet or was stopped.
STOPPING	Event Stream is stopping.
TRIAL_EXPIRED	Trial has expired, Event Stream will not start.

Method Summary

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

STOPPED

public static final EventStreamState STOPPED

Event Stream hasn't been started yet or was stopped. No events will be emitted.

STOPPING

public static final EventStreamState STOPPING

Event Stream is stopping. Waiting for events to finish processing.

TRIAL_EXPIRED

public static final EventStreamState TRIAL_EXPIRED

Trial has expired, Event Stream will not start.

STARTING_UP

public static final EventStreamState STARTING_UP

Event Stream is starting up. Source will not be subscribed, so no events will be emitted.

RUNNING

public static final EventStreamState RUNNING

Event Stream successfully started, source will be subscribed and receiving events.

DISABLED

public static final EventStreamState DISABLED

Event Stream is disabled. Source will not be subscribed, so no events will ever be emitted.

INACTIVE

public static final EventStreamState INACTIVE

Event Stream was started, but Gateway is inactive. Source will not be subscribed, so no events will be emitted.

FAULTED

public static final EventStreamState FAULTED

One or more stages are faulted. Source will not be subscribed, so no events will be emitted.

Method Details

values

public static EventStreamState[] 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 EventStreamState 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