net.scharlie.lj4l.core.io.local

Class LocalLineWriter

java.lang.Object

net.scharlie.lj4l.core.io.local.LocalLineWriter

All Implemented Interfaces:

Closeable, AutoCloseable, LineWriter

public class LocalLineWriter
extends Object
implements LineWriter

This class implements a local line writer.

Instances of this class are not safe for use by multiple threads.

Constructor Summary

Constructors

Constructor and Description
LocalLineWriter() Create a new local line writer.
LocalLineWriter(String path) Create a new local 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalLineWriter

public LocalLineWriter()

Create a new local line writer.

LocalLineWriter

public LocalLineWriter(String path)

Create a new local line writer.

Parameters:

path - The file path

Method Detail

setPath

public final void setPath(String path)

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

Specified by:

setPath in interface LineWriter

Parameters:

path - The file path

Throws:

IllegalStateException - if this writer is already closed

IllegalArgumentException - if the path is not null but blank

removePath

public final void removePath()

Remove the current file path.

Specified by:

removePath in interface LineWriter

writeLines

public final 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.

Specified by:

writeLines in interface LineWriter

Parameters:

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

Returns:

A result data transfer object

Throws:

IllegalStateException - if this writer is already closed

IllegalArgumentException - if the line supplier is null

IllegalArgumentException - if the path is null or empty

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LineWriter