com.inductiveautomation.gateway.tsdb.api

Enum Status

java.lang.Object

java.lang.Enum<Status>

com.inductiveautomation.gateway.tsdb.api.Status

All Implemented Interfaces:

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

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

Provides status for storage and query capabilities of a historian.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Available Indicates the service is available.
NotSupported 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 and Description
static Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Status[]	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

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.

NotSupported

public static final Status NotSupported

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

Method Detail

values

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

Returns:

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

valueOf

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