net.scharlie.lj4l.core.io

Interface LineReader

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

LocalLineReader, SftpLineReader

public interface LineReader
extends Closeable

This interface defines a line reader.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LineReader.LineConsumer Represents a line consumer which signals with its return value whether he will accept more input if available.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	exists(String pathToTest) Test whether the given file path exists.
ResultData	readLines(LineReader.LineConsumer lineConsumer) Read line by line until the current end.
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.

Method Detail

setPath

void setPath(String path)

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

Resets the internal pointer to the last imported byte.

Parameters:

path - The file path

Throws:

IllegalArgumentException - if the path is not null but blank

removePath

void removePath()

Remove the current file path.

readLines

ResultData readLines(LineReader.LineConsumer lineConsumer)

Read line by line until the current end.

Each call to this methods tries to continue reading after the last imported byte from the previous call.

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

The auto-connect flag is set to false.

Parameters:

lineConsumer - The consumer which takes line by line

Returns:

A result data transfer object

Throws:

IllegalArgumentException - if the line consumer is null

IllegalArgumentException - if the path is null or empty

exists

boolean exists(String pathToTest)

Test whether the given file path exists. The answer will be false if the file path does not exist or in case of any problem, e.g. no connection.

Parameters:

pathToTest - The file path

Returns:

answer whether the given file path exists

Throws:

IllegalArgumentException - if the path is null or blank

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable