Package com.couchbase.client.dcp.config

Enum Class CompressionMode

java.lang.Object

java.lang.Enum<CompressionMode>

com.couchbase.client.dcp.config.CompressionMode

All Implemented Interfaces:

Serializable, Comparable<CompressionMode>, java.lang.constant.Constable

public enum CompressionMode
extends Enum<CompressionMode>

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
DISABLED	Couchbase Server will never send compressed values.
ENABLED	Default mode.
FORCED	Couchbase Server will always send compressed values, regardless of how the values are stored on the server, unless the compressed form is larger than the uncompressed form.

Method Summary

Modifier and Type	Method	Description
abstract CompressionMode	effectiveMode(Version serverVersion)
abstract Map<String,String>	getDcpControls(Version serverVersion)
Set<HelloFeature>	getHelloFeatures(Version serverVersion)
static CompressionMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompressionMode[]	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

DISABLED

public static final CompressionMode DISABLED

Couchbase Server will never send compressed values.

FORCED

public static final CompressionMode FORCED

Couchbase Server will always send compressed values, regardless of how the values are stored on the server, unless the compressed form is larger than the uncompressed form.

When connecting to a server older than version 5.5, this mode will be downgraded to DISABLED.

Since:

Couchbase Server 5.5 (Vulcan)

ENABLED

public static final CompressionMode ENABLED

Default mode.

Couchbase Server may send compressed values at its discretion. Values stored in compressed form will be sent compressed. Values stored in uncompressed form will be sent uncompressed.

When connecting to a server older than version 5.5, this mode will be downgraded to DISABLED.

Since:

Couchbase Server 5.5 (Vulcan)

Method Details

values

public static CompressionMode[] 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 CompressionMode 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

effectiveMode

public abstract CompressionMode effectiveMode(Version serverVersion)

Returns:

the mode specified by this enum value, or the fallback mode as required by the actual server version.

getDcpControls

public abstract Map<String,String> getDcpControls(Version serverVersion)

Returns:

the controls required to activate this compression mode.

getHelloFeatures

public Set<HelloFeature> getHelloFeatures(Version serverVersion)

Returns:

the HELLO features required to activate this compression mode.