Package com.couchbase.client.dcp

Enum Class StreamTo

java.lang.Object

java.lang.Enum<StreamTo>

com.couchbase.client.dcp.StreamTo

All Implemented Interfaces:

Serializable, Comparable<StreamTo>, Constable

public enum StreamTo
extends Enum<StreamTo>

Up to which point the DCP stream should run.

Since:

1.0.0

Author:

Michael Nitschinger

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
static StreamTo	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StreamTo[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static StreamTo[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StreamTo valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null