io.nats.client.api

Enum ObjectStoreWatchOption

java.lang.Object

java.lang.Enum<ObjectStoreWatchOption>

io.nats.client.api.ObjectStoreWatchOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ObjectStoreWatchOption>

public enum ObjectStoreWatchOption
extends java.lang.Enum<ObjectStoreWatchOption>

Options for the Object Store Watcher

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE_DELETE Do not include deletes or purges in results.
INCLUDE_HISTORY Watch starting at the first entry for all keys.
UPDATES_ONLY Watch starting when there are new entries for keys.

Method Summary

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

IGNORE_DELETE

public static final ObjectStoreWatchOption IGNORE_DELETE

Do not include deletes or purges in results. Default is to include deletes.

INCLUDE_HISTORY

public static final ObjectStoreWatchOption INCLUDE_HISTORY

Watch starting at the first entry for all keys. Default is to start at the last per key.

UPDATES_ONLY

public static final ObjectStoreWatchOption UPDATES_ONLY

Watch starting when there are new entries for keys. Default is to start at the last per key.

Method Detail

values

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

Returns:

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

valueOf

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