Package org.apache.tinkerpop.gremlin.driver

Enum Class Compression

java.lang.Object

java.lang.Enum<Compression>

org.apache.tinkerpop.gremlin.driver.Compression

All Implemented Interfaces:

Serializable, Comparable<Compression>, Constable

public enum Compression
extends Enum<Compression>

The wire compression algorithm that the driver negotiates with the server. DEFLATE is the only algorithm the server negotiates today; other algorithms are reserved for future server-side support.

The default is DEFLATE (compression on); set NONE to disable. Disabling can be worthwhile when deflate adds CPU and latency with no wire-size benefit, such as on incompressible or tiny payloads.

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
DEFLATE	Request deflate compression by sending an Accept-Encoding: deflate header.
NONE	No compression.

Method Summary

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

NONE

public static final Compression NONE

No compression. The driver does not request a compressed response from the server.

DEFLATE

public static final Compression DEFLATE

Request deflate compression by sending an Accept-Encoding: deflate header. The server compresses responses per GraphBinary chunk when this is negotiated.

Method Details

values

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