FileIO.ReadableFile

java.lang.Object
- org.apache.beam.sdk.io.FileIO.ReadableFile

Enclosing class:

FileIO
```
public static final class FileIO.ReadableFile
extends java.lang.Object
```
A utility class for accessing a potentially compressed file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Compression`	`getCompression()` Returns the method with which this file will be decompressed in `open()`.
`MatchResult.Metadata`	`getMetadata()` Returns the `MatchResult.Metadata` of the file.
`java.nio.channels.ReadableByteChannel`	`open()` Returns a `ReadableByteChannel` reading the data from this file, potentially decompressing it using `getCompression()`.
`java.nio.channels.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.
`java.lang.String`	`readFullyAsUTF8String()` Returns the full contents of the file as a `String` decoded as UTF-8.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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 java.nio.channels.ReadableByteChannel open()
                                           throws java.io.IOException
```
    Returns a ReadableByteChannel reading the data from this file, potentially decompressing it using getCompression().
    
    Throws:
    
    java.io.IOException
  - openSeekable
```
public java.nio.channels.SeekableByteChannel openSeekable()
                                                   throws java.io.IOException
```
    Returns a SeekableByteChannel equivalent to open(), but fails if this file is not seekable.
    
    Throws:
    
    java.io.IOException
  - readFullyAsBytes
```
public byte[] readFullyAsBytes()
                        throws java.io.IOException
```
    Returns the full contents of the file as bytes.
    
    Throws:
    
    java.io.IOException
  - readFullyAsUTF8String
```
public java.lang.String readFullyAsUTF8String()
                                       throws java.io.IOException
```
    Returns the full contents of the file as a String decoded as UTF-8.
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class FileIO.ReadableFile

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMetadata

getCompression

open

openSeekable

readFullyAsBytes

readFullyAsUTF8String

toString