org.embulk.spi

Interface FileInput

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

TransactionalFileInput

public interface FileInput
extends AutoCloseable

Represents a series of file-like byte sequence inputs from a File Input Plugin.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
void	close() Closes this FileInput.
default Optional<String>	hintOfCurrentInputFileNameForLogging() Gets a String that hints the name of the current file input.
boolean	nextFile() Switches the FileInput to process the next file.
Buffer	poll() Reads a byte sequence from this FileInput into Buffer.

Method Detail

nextFile

boolean nextFile()

Switches the FileInput to process the next file.

Returns:

true if this FileInput has switched to the next file. false if no more files.

Since:

0.4.0

poll

Buffer poll()

Reads a byte sequence from this FileInput into Buffer.

Returns:

the Buffer read

Since:

0.4.0

close

void close()

Closes this FileInput.

Specified by:

close in interface AutoCloseable

Since:

0.4.0

hintOfCurrentInputFileNameForLogging

default Optional<String> hintOfCurrentInputFileNameForLogging()

Gets a String that hints the name of the current file input.

The hint is only for human-readable logs, not to be stored as any record. Nothing is guaranteed in the hint. Plugins may change the hint without any notification when upgraded. The hint can be lost through a chain of plugin calls -- File Input Plugin, Decoder Plugins, and Parser Plugin.

Returns:

the hinting String in Optional

Since:

0.9.12