io.realm.sync

Enum Subscription.State

java.lang.Object

java.lang.Enum<Subscription.State>

io.realm.sync.Subscription.State

All Implemented Interfaces:

Serializable, Comparable<Subscription.State>

Enclosing class:

Subscription

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

The different states a Subscription can be in.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE The subscription has been processed by the Realm Object Server and data is being synced to the device.
ERROR An error occurred while creating or processing the subscription.
INVALIDATED The subscription has been removed.
PENDING The subscription has been created, but has not yet been processed by the sync server.

Method Summary

Modifier and Type	Method and Description
Byte	getValue() Returns the native value representing this state.
static Subscription.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Subscription.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

ERROR

public static final Subscription.State ERROR

An error occurred while creating or processing the subscription. See Subscription.getErrorMessage() for details on what went wrong.

PENDING

public static final Subscription.State PENDING

The subscription has been created, but has not yet been processed by the sync server.

ACTIVE

public static final Subscription.State ACTIVE

The subscription has been processed by the Realm Object Server and data is being synced to the device.

INVALIDATED

public static final Subscription.State INVALIDATED

The subscription has been removed. Data is no longer being synchronized from the Realm Object Server, and the objects covered by this subscription might be deleted from the device if no other subscriptions include them.

Method Detail

values

public static Subscription.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 (Subscription.State c : Subscription.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 Subscription.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

getValue

public Byte getValue()

Returns the native value representing this state.

Returns:

the native value representing this state.