com.couchbase.client.java.util.features

Enum CouchbaseFeature

java.lang.Object

java.lang.Enum<CouchbaseFeature>

com.couchbase.client.java.util.features.CouchbaseFeature

All Implemented Interfaces:

Serializable, Comparable<CouchbaseFeature>

public enum CouchbaseFeature
extends Enum<CouchbaseFeature>

Enumeration of all Couchbase Features supported by this SDK.

Since:

2.1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CCCP
DCP
KV
N1QL
SPATIAL_VIEW
SSL
VIEW

Method Summary

Modifier and Type	Method and Description
boolean	isAvailableOn(Version serverVersion) Checks if this feature is available on the provided server version.
static CouchbaseFeature	valueOf(String name) Returns the enum constant of this type with the specified name.
static CouchbaseFeature[]	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

KV

public static final CouchbaseFeature KV

VIEW

public static final CouchbaseFeature VIEW

CCCP

public static final CouchbaseFeature CCCP

SSL

public static final CouchbaseFeature SSL

DCP

public static final CouchbaseFeature DCP

N1QL

public static final CouchbaseFeature N1QL

SPATIAL_VIEW

public static final CouchbaseFeature SPATIAL_VIEW

Method Detail

values

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

Returns:

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

valueOf

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

isAvailableOn

public boolean isAvailableOn(Version serverVersion)

Checks if this feature is available on the provided server version.

Parameters:

serverVersion - the server side version to check against

Returns:

true if this feature is available on the given version, false otherwise.