Package com.inductiveautomation.ignition.gateway.storeforward.sinks.info

Enum Class SinkStatus

java.lang.Object

java.lang.Enum<SinkStatus>

com.inductiveautomation.ignition.gateway.storeforward.sinks.info.SinkStatus

All Implemented Interfaces:

Serializable, Comparable<SinkStatus>, Constable

public enum SinkStatus
extends Enum<SinkStatus>

Enum representing the status of a data sink.

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
ACCEPTING	The sink is accepting data and can process them.
FAULTED	The sink has faulted and cannot be used to process data.
INITIALIZING	The sink is initializing and cannot process data.
NOT_ACCEPTING	The sink is not accepting data and cannot process them.
STARTED	The sink is still in a starting state and cannot process data.
STOPPED	The sink is stopped and cannot process data.
UNINITIALIZED	The sink is uninitialized and cannot process data.
UNLICENSED	The sink is not licensed and cannot process data.

Method Summary

Modifier and Type	Method	Description
boolean	isAccepting()	Returns true if the sink is currently accepting data.
static SinkStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SinkStatus[]	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

ACCEPTING

public static final SinkStatus ACCEPTING

The sink is accepting data and can process them.

NOT_ACCEPTING

public static final SinkStatus NOT_ACCEPTING

The sink is not accepting data and cannot process them.

UNLICENSED

public static final SinkStatus UNLICENSED

The sink is not licensed and cannot process data.

STARTED

public static final SinkStatus STARTED

The sink is still in a starting state and cannot process data.

INITIALIZING

public static final SinkStatus INITIALIZING

The sink is initializing and cannot process data.

UNINITIALIZED

public static final SinkStatus UNINITIALIZED

The sink is uninitialized and cannot process data.

STOPPED

public static final SinkStatus STOPPED

The sink is stopped and cannot process data.

FAULTED

public static final SinkStatus FAULTED

The sink has faulted and cannot be used to process data.

Method Details

values

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

isAccepting

public boolean isAccepting()

Returns true if the sink is currently accepting data.

Returns:

whether the sink is accepting data