Package com.couchbase.client.java.manager.bucket

Enum CompressionMode

java.lang.Object

java.lang.Enum<CompressionMode>

com.couchbase.client.java.manager.bucket.CompressionMode

All Implemented Interfaces:

Serializable, Comparable<CompressionMode>

@Volatile
public enum CompressionMode
extends Enum<CompressionMode>

Specifies the compression mode used on the bucket.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Compression mode Active.
OFF	Compression mode Off.
PASSIVE	Compression mode Passive.

Method Summary

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

OFF

public static final CompressionMode OFF

Compression mode Off.

Compressed documents are accepted but actively decompressed for storage in memory and for streaming. Not advised!

PASSIVE

public static final CompressionMode PASSIVE

Compression mode Passive.

Compressed documents can be stored and streamed from the server, but the server does not try to actively compress documents (client-initiated).

ACTIVE

public static final CompressionMode ACTIVE

Compression mode Active.

The server will try to actively compress documents in memory.

Method Detail

values

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

Returns:

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

valueOf

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

alias

@Internal
public String alias()