net.openhft.chronicle.bytes.util

Enum Compressions

java.lang.Object

java.lang.Enum<Compressions>

net.openhft.chronicle.bytes.util.Compressions

All Implemented Interfaces:

Serializable, Comparable<Compressions>, Compression

public enum Compressions
extends Enum<Compressions>
implements Compression

Compression algorithms supported by Chronicle Bytes. Each enum constant provides Compression implementations for stream-based compression and decompression.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Binary Represents a no-operation compression strategy.
GZIP Uses GZIPInputStream and GZIPOutputStream.
LZW Uses InflaterInputStream and DeflaterOutputStream in a DEFLATE variant of LZW.

Method Summary

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

Methods inherited from interface net.openhft.chronicle.bytes.util.Compression

available, compress, compress, compress, compressingStream, decompressingStream, uncompress, uncompress, uncompress, uncompress

Enum Constant Detail

Binary

public static final Compressions Binary

Represents a no-operation compression strategy. The data is passed through unchanged and no CPU time is spent compressing or expanding it.

See Also:

Compression

LZW

public static final Compressions LZW

Uses InflaterInputStream and DeflaterOutputStream in a DEFLATE variant of LZW. Provides modest compression ratios at a low CPU cost.

See Also:

Compression

GZIP

public static final Compressions GZIP

Uses GZIPInputStream and GZIPOutputStream. GZIP typically yields higher compression at increased CPU usage and is defined in RFC 1952.

See Also:

Compression

Method Detail

values

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

Returns:

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

valueOf

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