Package org.scictrl.csshell

Enum Class Status.State

java.lang.Object

java.lang.Enum<Status.State>

org.scictrl.csshell.Status.State

All Implemented Interfaces:

Serializable, Comparable<Status.State>, Constable

Enclosing class:

Status

public static enum Status.State
extends Enum<Status.State>

State

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
ALARM	Remote value has reached alarm threshold
CLOSED	Connection was closed and destroyed
CONNECTED	Connection is established.
FAILED	Connection failed while establishing
INITIAL	Connection was never established.
INVALID	We might not have valid remote value
LOST	Connection currently not available, but was connected erlier
NORMAL	Normal situation, no alarms or erors
UNDEFINED	There is no status information.
WARNING	Remote value has reached warning threshold

Method Summary

Modifier and Type	Method	Description
int	getCode()	Returns status code.
String	getDescription()	Returns description
boolean	isSet(int i)	Returns true if bit is set
int	set(int i)	Sets bits
int	unset(int i)	Flips off bits agains status code
static Status.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Status.State[]	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

UNDEFINED

public static final Status.State UNDEFINED

There is no status information.

INITIAL

public static final Status.State INITIAL

Connection was never established.

CONNECTED

public static final Status.State CONNECTED

Connection is established.

FAILED

public static final Status.State FAILED

Connection failed while establishing

LOST

public static final Status.State LOST

Connection currently not available, but was connected erlier

CLOSED

public static final Status.State CLOSED

Connection was closed and destroyed

WARNING

public static final Status.State WARNING

Remote value has reached warning threshold

ALARM

public static final Status.State ALARM

Remote value has reached alarm threshold

INVALID

public static final Status.State INVALID

We might not have valid remote value

NORMAL

public static final Status.State NORMAL

Normal situation, no alarms or erors

Method Details

values

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

getCode

public int getCode()

Returns status code.

Returns:

status code

getDescription

public String getDescription()

Returns description

Returns:

description

unset

public int unset(int i)

Flips off bits agains status code

Parameters:

i - bits to flip

Returns:

result

set

public int set(int i)

Sets bits

Parameters:

i - bits to set

Returns:

result

isSet

public boolean isSet(int i)

Returns true if bit is set

Parameters:

i - bit

Returns:

true if bit is set