de.ocarthon.libArcus

Enum SocketState

java.lang.Object

java.lang.Enum<SocketState>

de.ocarthon.libArcus.SocketState

All Implemented Interfaces:

Serializable, Comparable<SocketState>

public enum SocketState
extends Enum<SocketState>

Represents all possible states a ArcusSocket can be in. The state of a created ArcusSocket can be obtained by calling ArcusSocket.getState().

If a SocketListener has been added by calling ArcusSocket.addListener(SocketListener), SocketListener.error(ArcusSocket, de.ocarthon.libArcus.Error) will be called when the state of this socket changes

More detailed documentation to the different states can be found in ArcusSocket.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Closed
Closing
Connected
Connecting
Error
Initial
Listening
Opening

Method Summary

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

Initial

public static final SocketState Initial

Connecting

public static final SocketState Connecting

Connected

public static final SocketState Connected

Opening

public static final SocketState Opening

Listening

public static final SocketState Listening

Closing

public static final SocketState Closing

Closed

public static final SocketState Closed

Error

public static final SocketState Error

Method Detail

values

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

Returns:

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

valueOf

public static SocketState valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null