Package org.apache.iceberg.io

Interface OutputFile

All Known Subinterfaces:

NativeEncryptionOutputFile

All Known Implementing Classes:

AesGcmOutputFile, HadoopOutputFile, InMemoryOutputFile, S3OutputFile

public interface OutputFile

An interface used to create output files using PositionOutputStream instances.

This class is based on Parquet's InputFile.

Method Summary

Modifier and Type	Method	Description
PositionOutputStream	create()	Create a new file and return a PositionOutputStream to it.
PositionOutputStream	createOrOverwrite()	Create a new file and return a PositionOutputStream to it.
String	location()	Return the location this output file will create.
InputFile	toInputFile()	Return an InputFile for the location of this output file.

Method Details

create

PositionOutputStream create()

Create a new file and return a PositionOutputStream to it.

If the file already exists, this will throw an exception.

Returns:

an output stream that can report its position

Throws:

AlreadyExistsException - If the path already exists

RuntimeIOException - If the implementation throws an IOException

createOrOverwrite

PositionOutputStream createOrOverwrite()

Create a new file and return a PositionOutputStream to it.

If the file already exists, this will not throw an exception and will replace the file.

Returns:

an output stream that can report its position

Throws:

RuntimeIOException - If the implementation throws an IOException

SecurityException - If staging directory creation fails due to missing JVM level permission

location

String location()

Return the location this output file will create.

Returns:

the location of this output file

toInputFile

InputFile toInputFile()

Return an InputFile for the location of this output file.

Returns:

an input file for the location of this output file