com.cloudant.sync.replication

Enum Replicator.State

java.lang.Object

java.lang.Enum<Replicator.State>

com.cloudant.sync.replication.Replicator.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Replicator.State>

Enclosing interface:

Replicator

public static enum Replicator.State
extends java.lang.Enum<Replicator.State>

Describes the state of a Replicator at a given moment.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE The last replication successfully completed.
ERROR The last replication completed in error.
PENDING The replicator is initialised and is ready to start.
STARTED A replication is in progress.
STOPPED The last replication was stopped using Replicator.stop().
STOPPING Replicator.stop() has been called and the replicator is stopping its worker threads.

Method Summary

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

PENDING

public static final Replicator.State PENDING

The replicator is initialised and is ready to start.

STARTED

public static final Replicator.State STARTED

A replication is in progress.

STOPPED

public static final Replicator.State STOPPED

The last replication was stopped using Replicator.stop().

STOPPING

public static final Replicator.State STOPPING

Replicator.stop() has been called and the replicator is stopping its worker threads.

COMPLETE

public static final Replicator.State COMPLETE

The last replication successfully completed.

ERROR

public static final Replicator.State ERROR

The last replication completed in error.

Method Detail

values

public static Replicator.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 (Replicator.State c : Replicator.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 Replicator.State valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null