Package com.github.copilot.sdk

Enum Class ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

com.github.copilot.sdk.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>, Constable

public enum ConnectionState
extends Enum<ConnectionState>

Represents the connection state of a CopilotClient.

The connection state indicates the current status of the client's connection to the Copilot CLI server.

Since:

1.0.0

See Also:

• CopilotClient.getState()

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
CONNECTED	The client is connected and ready to accept requests.
CONNECTING	The client is in the process of connecting to the server.
DISCONNECTED	The client is not connected to the server.
ERROR	The client encountered an error during connection or operation.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISCONNECTED

public static final ConnectionState DISCONNECTED

The client is not connected to the server.

CONNECTING

public static final ConnectionState CONNECTING

The client is in the process of connecting to the server.

CONNECTED

public static final ConnectionState CONNECTED

The client is connected and ready to accept requests.

ERROR

public static final ConnectionState ERROR

The client encountered an error during connection or operation.

Method Details

values

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