BuiltInGzipDecompressor.GzipStateLabel (Apache Hadoop Common 3.4.1.300-dep-1001 API)

java.lang.Object
- java.lang.Enum<BuiltInGzipDecompressor.GzipStateLabel>
- - org.apache.hadoop.io.compress.zlib.BuiltInGzipDecompressor.GzipStateLabel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BuiltInGzipDecompressor.GzipStateLabel>

Enclosing class:

BuiltInGzipDecompressor
```
public static enum BuiltInGzipDecompressor.GzipStateLabel
extends java.lang.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.)

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

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static BuiltInGzipDecompressor.GzipStateLabel`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static BuiltInGzipDecompressor.GzipStateLabel[]`	`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
  - 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 Detail
  - values
```
public static BuiltInGzipDecompressor.GzipStateLabel[] 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 (BuiltInGzipDecompressor.GzipStateLabel c : BuiltInGzipDecompressor.GzipStateLabel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BuiltInGzipDecompressor.GzipStateLabel valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum BuiltInGzipDecompressor.GzipStateLabel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

HEADER_BASIC

HEADER_EXTRA_FIELD

HEADER_FILENAME

HEADER_COMMENT

HEADER_CRC

DEFLATE_STREAM

INFLATE_STREAM

TRAILER_CRC

TRAILER_SIZE

FINISHED

ENDED

Method Detail

values

valueOf