Package io.realm.mongodb.sync

Enum SubscriptionSet.State

java.lang.Object

java.lang.Enum<SubscriptionSet.State>

io.realm.mongodb.sync.SubscriptionSet.State

All Implemented Interfaces:

Serializable, Comparable<SubscriptionSet.State>

Enclosing interface:

SubscriptionSet

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

The possible states a subscription set can be in.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOTSTRAPPING	A subscription set was accepted by the server and initial data is being sent to the device.
COMPLETE	A subscription set is actively synchronizing data between the server and the device.
ERROR	An error occurred in the subscription set or one of the subscriptions.
PENDING	A subscription set has been modified locally, but is still waiting to be sent to the server.
SUPERSEDED	Another subscription set was stored before this one, the changes made to this set are ignorde by the server.
UNCOMMITTED	The initial state of subscriptions when opening a new Realm or when entering a SubscriptionSet.update(UpdateCallback).

Method Summary

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

UNCOMMITTED

public static final SubscriptionSet.State UNCOMMITTED

The initial state of subscriptions when opening a new Realm or when entering a SubscriptionSet.update(UpdateCallback).

PENDING

public static final SubscriptionSet.State PENDING

A subscription set has been modified locally, but is still waiting to be sent to the server.

BOOTSTRAPPING

public static final SubscriptionSet.State BOOTSTRAPPING

A subscription set was accepted by the server and initial data is being sent to the device.

COMPLETE

public static final SubscriptionSet.State COMPLETE

A subscription set is actively synchronizing data between the server and the device.

ERROR

public static final SubscriptionSet.State ERROR

An error occurred in the subscription set or one of the subscriptions. The cause is found in SubscriptionSet.getErrorMessage().

SUPERSEDED

public static final SubscriptionSet.State SUPERSEDED

Another subscription set was stored before this one, the changes made to this set are ignorde by the server. Get the latest subscription set by calling BaseRealm.getSubscriptions().

Method Detail

values

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

Returns:

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

valueOf

public static SubscriptionSet.State 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

fromNativeValue

public static SubscriptionSet.State fromNativeValue(long value)