Package com.inductiveautomation.historian.gateway.api.query

Enum Class ResultPublisher.PublisherState

java.lang.Object

java.lang.Enum<ResultPublisher.PublisherState>

com.inductiveautomation.historian.gateway.api.query.ResultPublisher.PublisherState

All Implemented Interfaces:

Serializable, Comparable<ResultPublisher.PublisherState>, Constable

Enclosing interface:

ResultPublisher<K>

public static enum ResultPublisher.PublisherState
extends Enum<ResultPublisher.PublisherState>

Enum representing the possible states of the publisher.

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
CANCELED
ERRORED
FINISHED
INITIAL
PUBLISHING

Method Summary

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

INITIAL

public static final ResultPublisher.PublisherState INITIAL

PUBLISHING

public static final ResultPublisher.PublisherState PUBLISHING

CANCELED

public static final ResultPublisher.PublisherState CANCELED

FINISHED

public static final ResultPublisher.PublisherState FINISHED

ERRORED

public static final ResultPublisher.PublisherState ERRORED

Method Details

values

public static ResultPublisher.PublisherState[] 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 ResultPublisher.PublisherState 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