Package org.apache.beam.sdk.io

Class FileIO.ReadableFile

java.lang.Object

org.apache.beam.sdk.io.FileIO.ReadableFile

Enclosing class:

FileIO

public static final class FileIO.ReadableFile
extends Object

A utility class for accessing a potentially compressed file.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
Compression	getCompression()	Returns the method with which this file will be decompressed in open().
MatchResult.Metadata	getMetadata()	Returns the MatchResult.Metadata of the file.
int	hashCode()
ReadableByteChannel	open()	Returns a ReadableByteChannel reading the data from this file, potentially decompressing it using getCompression().
SeekableByteChannel	openSeekable()	Returns a SeekableByteChannel equivalent to open(), but fails if this file is not seekable.
byte[]	readFullyAsBytes()	Returns the full contents of the file as bytes.
String	readFullyAsUTF8String()	Returns the full contents of the file as a String decoded as UTF-8.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getMetadata

public MatchResult.Metadata getMetadata()

Returns the MatchResult.Metadata of the file.

getCompression

public Compression getCompression()

Returns the method with which this file will be decompressed in open().

open

public ReadableByteChannel open()
                         throws IOException

Returns a ReadableByteChannel reading the data from this file, potentially decompressing it using getCompression().

Throws:

IOException

openSeekable

public SeekableByteChannel openSeekable()
                                 throws IOException

Returns a SeekableByteChannel equivalent to open(), but fails if this file is not seekable.

Throws:

IOException

readFullyAsBytes

public byte[] readFullyAsBytes()
                        throws IOException

Returns the full contents of the file as bytes.

Throws:

IOException

readFullyAsUTF8String

public String readFullyAsUTF8String()
                             throws IOException

Returns the full contents of the file as a String decoded as UTF-8.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object