com.couchbase.client.dcp

Enum StreamTo

java.lang.Object

java.lang.Enum<StreamTo>

com.couchbase.client.dcp.StreamTo

All Implemented Interfaces:

Serializable, Comparable<StreamTo>

public enum StreamTo
extends Enum<StreamTo>

Up to which point the DCP stream should run.

Since:

1.0.0

Author:

Michael Nitschinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
INFINITY Never stop streaming automatically, but manual stream stop is of course possible.
NOW Stop "now", where now is the time when the state is initialized that way.

Method Summary

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

NOW

public static final StreamTo NOW

Stop "now", where now is the time when the state is initialized that way.

INFINITY

public static final StreamTo INFINITY

Never stop streaming automatically, but manual stream stop is of course possible.

Method Detail

values

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

Returns:

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

valueOf

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