org.eclipse.eavp.viz.service.connections

Enum ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

org.eclipse.eavp.viz.service.connections.ConnectionState

All Implemented Interfaces:

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

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

This enum defines the possible states of a viz service connection. This is intended for use with the viz plots so they can keep users updated based on the state of the associated connection.

Author:

Jordan Deyton

Enum Constant Summary

Enum Constants

Enum Constant and Description
Connected The connection is opened.
Connecting The connection is being established.
Disconnected The connection is closed.
Failed The connection failed to open.

Method Summary

Modifier and Type	Method and Description
static ConnectionState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConnectionState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Connecting

public static final ConnectionState Connecting

The connection is being established.

Connected

public static final ConnectionState Connected

The connection is opened.

Failed

public static final ConnectionState Failed

The connection failed to open.

Disconnected

public static final ConnectionState Disconnected

The connection is closed.

Method Detail

values

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

Returns:

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

valueOf

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