io.realm.mongodb.sync

Enum ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

io.realm.mongodb.sync.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>

public enum ConnectionState
extends Enum<ConnectionState>

Enum describing the states of the underlying connection used by a SyncSession.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED A connection was successfully established to the server.
CONNECTING A connection is currently in progress of being established.
DISCONNECTED No connection to the server exists.

Method Summary

Modifier and Type	Method and Description
static ConnectionState	valueOf(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

DISCONNECTED

public static final ConnectionState DISCONNECTED

No connection to the server exists. No data is being transferred even if the session is SyncSession.State.ACTIVE. If the connection entered this state due to an error, this error will be reported to the SyncSession.ErrorHandler.

CONNECTING

public static final ConnectionState CONNECTING

A connection is currently in progress of being established. If successful the next state is CONNECTED. If the connection fails it will be DISCONNECTED.

CONNECTED

public static final ConnectionState CONNECTED

A connection was successfully established to the server. If the SyncSession is SyncSession.State.ACTIVE data will now be transferred between the device and the server.

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(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