net.scharlie.lj4l.core.io

Interface LineWriter

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

LocalLineWriter, SftpLineWriter

public interface LineWriter
extends Closeable

This interface defines a line writer.

Method Summary

Modifier and Type	Method and Description
void	close()
void	removePath() Remove the current file path.
void	setPath(String path) Set the file path or null if you want to remove the current file path.
ResultData	writeLines(Supplier<String> lineSupplier) Write line by line until the line supplier provides a null value.

Method Detail

setPath

void setPath(String path)

Set the file path or null if you want to remove the current file path.

Parameters:

path - The file path

Throws:

IllegalArgumentException - if the path is not null but blank

removePath

void removePath()

Remove the current file path.

writeLines

ResultData writeLines(Supplier<String> lineSupplier)

Write line by line until the line supplier provides a null value.

Each call to this methods tries to continue writing after the last exported byte from the previous call.

The internal pointer to the last exported byte can and will be reseted by setting or removing the path.

The auto-connect flag is set to false.

Parameters:

lineSupplier - The supplier which provides line by line. A null value indicates the end.

Returns:

A result data transfer object

Throws:

IllegalArgumentException - if the line supplier is null

IllegalArgumentException - if the path is null or empty

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable