com.caplin.streamlink.alerts

Enum TriggerState

java.lang.Object

java.lang.Enum<TriggerState>

com.caplin.streamlink.alerts.TriggerState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TriggerState>

public enum TriggerState
extends java.lang.Enum<TriggerState>

Enumeration that defines the different states a Trigger can be in

Enum Constant Summary

Enum Constants

Enum Constant and 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

Methods

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

public static TriggerState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null