Package com.caplin.streamlink.alerts

Enum Class TriggerState

java.lang.Object

java.lang.Enum<TriggerState>

com.caplin.streamlink.alerts.TriggerState

All Implemented Interfaces:

Serializable, Comparable<TriggerState>, Constable

public enum TriggerState
extends Enum<TriggerState>

Enumeration that defines the different states a Trigger can be in

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
ACTIVE	the trigger is active and waiting for the condition to be met
INACTIVE	the trigger is disabled/paused and will not trigger if the condition is met
TRIGGERED	the condition was met and a notification was triggered
UNKNOWN	Invalid state that only happens if the backend sends an unsupported state

Method Summary

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

ACTIVE

public static final TriggerState ACTIVE

the trigger is active and waiting for the condition to be met

INACTIVE

public static final TriggerState INACTIVE

the trigger is disabled/paused and will not trigger if the condition is met

TRIGGERED

public static final TriggerState TRIGGERED

the condition was met and a notification was triggered

UNKNOWN

public static final TriggerState UNKNOWN

Invalid state that only happens if the backend sends an unsupported state

Method Details

values

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