org.apache.beam.sdk.io

Enum CompressedSource.CompressionMode

java.lang.Object

java.lang.Enum<CompressedSource.CompressionMode>

org.apache.beam.sdk.io.CompressedSource.CompressionMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CompressedSource.CompressionMode>, CompressedSource.DecompressingChannelFactory

Enclosing class:

CompressedSource<T>

public static enum CompressedSource.CompressionMode
extends java.lang.Enum<CompressedSource.CompressionMode>
implements CompressedSource.DecompressingChannelFactory

Default compression types supported by the CompressedSource.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BZIP2 Reads a byte channel assuming it is compressed with bzip2.
DEFLATE Reads a byte channel assuming it is compressed with deflate.
GZIP Reads a byte channel assuming it is compressed with gzip.
ZIP Reads a byte channel assuming it is compressed with zip.

Method Summary

Modifier and Type	Method and Description
abstract java.nio.channels.ReadableByteChannel	createDecompressingChannel(java.nio.channels.ReadableByteChannel channel) Given a channel, create a channel that decompresses the content read from the channel.
abstract boolean	matches(java.lang.String fileName) Returns true if the given file name implies that the contents are compressed according to the compression embodied by this factory.
static CompressedSource.CompressionMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CompressedSource.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

GZIP

public static final CompressedSource.CompressionMode GZIP

Reads a byte channel assuming it is compressed with gzip.

BZIP2

public static final CompressedSource.CompressionMode BZIP2

Reads a byte channel assuming it is compressed with bzip2.

ZIP

public static final CompressedSource.CompressionMode ZIP

Reads a byte channel assuming it is compressed with zip. If the zip file contains multiple entries, files in the zip are concatenated all together.

DEFLATE

public static final CompressedSource.CompressionMode DEFLATE

Reads a byte channel assuming it is compressed with deflate.

Method Detail

values

public static CompressedSource.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 (CompressedSource.CompressionMode c : CompressedSource.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 CompressedSource.CompressionMode 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

matches

public abstract boolean matches(java.lang.String fileName)

Returns true if the given file name implies that the contents are compressed according to the compression embodied by this factory.

createDecompressingChannel

public abstract java.nio.channels.ReadableByteChannel createDecompressingChannel(java.nio.channels.ReadableByteChannel channel)
                                                                          throws java.io.IOException

Description copied from interface: CompressedSource.DecompressingChannelFactory

Given a channel, create a channel that decompresses the content read from the channel.

Specified by:

createDecompressingChannel in interface CompressedSource.DecompressingChannelFactory

Throws:

java.io.IOException