Package com.inductiveautomation.historian.gateway.api

Enum Class Status

java.lang.Object

java.lang.Enum<Status>

com.inductiveautomation.historian.gateway.api.Status

All Implemented Interfaces:

Serializable, Comparable<Status>, Constable

public enum Status
extends Enum<Status>

Provides status for storage and query capabilities of a historian.

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
AVAILABLE	Indicates the service is available.
NOT_SUPPORTED	Indicates the service isn't supported and will not become available.
UNAVAILABLE	Indicates the service is supported, but not currently available.

Method Summary

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

UNAVAILABLE

public static final Status UNAVAILABLE

Indicates the service is supported, but not currently available.

AVAILABLE

public static final Status AVAILABLE

Indicates the service is available.

NOT_SUPPORTED

public static final Status NOT_SUPPORTED

Indicates the service isn't supported and will not become available.

Method Details

values

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