com.couchbase.client.dcp

Enum StreamFrom

java.lang.Object

java.lang.Enum<StreamFrom>

com.couchbase.client.dcp.StreamFrom

All Implemented Interfaces:

Serializable, Comparable<StreamFrom>

public enum StreamFrom
extends Enum<StreamFrom>

From which point in time to start the DCP stream.

Since:

1.0.0

Author:

Michael Nitschinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEGINNING Start at the very beginning - will stream all docs in the bucket.
NOW Start "now", where now is a time point of execution in the running program where the state is gathered from each partition.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BEGINNING

public static final StreamFrom BEGINNING

Start at the very beginning - will stream all docs in the bucket.

NOW

public static final StreamFrom NOW

Start "now", where now is a time point of execution in the running program where the state is gathered from each partition. Mutations will be streamed after this point.

Method Detail

values

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

Returns:

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

valueOf

public static StreamFrom 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