Package org.apache.hadoop.io.compress.zlib

Enum Class BuiltInGzipDecompressor.GzipStateLabel

java.lang.Object

java.lang.Enum<BuiltInGzipDecompressor.GzipStateLabel>

org.apache.hadoop.io.compress.zlib.BuiltInGzipDecompressor.GzipStateLabel

All Implemented Interfaces:

Serializable, Comparable<BuiltInGzipDecompressor.GzipStateLabel>, Constable

Enclosing class:

org.apache.hadoop.io.compress.zlib.BuiltInGzipDecompressor

public static enum BuiltInGzipDecompressor.GzipStateLabel
extends Enum<BuiltInGzipDecompressor.GzipStateLabel>

The current state of the gzip decoder, external to the Inflater context. (Technically, the private variables localBuf through hasHeaderCRC are also part of the state, so this enum is merely the label for it.)

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_STREAM	Immediately prior to or within the main compressed (deflate) data stream.
ENDED	Immediately after end() has been called.
FINISHED	Immediately after the trailer (and potentially prior to the next gzip member/substream header), without reset() having been called.
HEADER_BASIC	Immediately prior to or (strictly) within the 10-byte basic gzip header.
HEADER_COMMENT	Immediately prior to or within the optional comment field.
HEADER_CRC	Immediately prior to or within the optional 2-byte header CRC value.
HEADER_EXTRA_FIELD	Immediately prior to or within the optional "extra field."
HEADER_FILENAME	Immediately prior to or within the optional filename field.
INFLATE_STREAM	Immediately prior to or within the main uncompressed (inflate) data stream.
TRAILER_CRC	Immediately prior to or (strictly) within the 4-byte uncompressed CRC.
TRAILER_SIZE	Immediately prior to or (strictly) within the 4-byte uncompressed size.

Method Summary

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

HEADER_BASIC

public static final BuiltInGzipDecompressor.GzipStateLabel HEADER_BASIC

Immediately prior to or (strictly) within the 10-byte basic gzip header.

HEADER_EXTRA_FIELD

public static final BuiltInGzipDecompressor.GzipStateLabel HEADER_EXTRA_FIELD

Immediately prior to or within the optional "extra field."

HEADER_FILENAME

public static final BuiltInGzipDecompressor.GzipStateLabel HEADER_FILENAME

Immediately prior to or within the optional filename field.

HEADER_COMMENT

public static final BuiltInGzipDecompressor.GzipStateLabel HEADER_COMMENT

Immediately prior to or within the optional comment field.

HEADER_CRC

public static final BuiltInGzipDecompressor.GzipStateLabel HEADER_CRC

Immediately prior to or within the optional 2-byte header CRC value.

DEFLATE_STREAM

public static final BuiltInGzipDecompressor.GzipStateLabel DEFLATE_STREAM

Immediately prior to or within the main compressed (deflate) data stream.

INFLATE_STREAM

public static final BuiltInGzipDecompressor.GzipStateLabel INFLATE_STREAM

Immediately prior to or within the main uncompressed (inflate) data stream.

TRAILER_CRC

public static final BuiltInGzipDecompressor.GzipStateLabel TRAILER_CRC

Immediately prior to or (strictly) within the 4-byte uncompressed CRC.

TRAILER_SIZE

public static final BuiltInGzipDecompressor.GzipStateLabel TRAILER_SIZE

Immediately prior to or (strictly) within the 4-byte uncompressed size.

FINISHED

public static final BuiltInGzipDecompressor.GzipStateLabel FINISHED

Immediately after the trailer (and potentially prior to the next gzip member/substream header), without reset() having been called.

ENDED

public static final BuiltInGzipDecompressor.GzipStateLabel ENDED

Immediately after end() has been called.

Method Details

values

public static BuiltInGzipDecompressor.GzipStateLabel[] 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 BuiltInGzipDecompressor.GzipStateLabel 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