org.unix4j.io

Class BufferedInput

java.lang.Object

org.unix4j.io.AbstractInput

org.unix4j.io.BufferedInput

All Implemented Interfaces:

AutoCloseable, Iterable<Line>, Input

public class BufferedInput
extends AbstractInput

Input device based on a LinkedList line buffer.

Constructor Summary

Constructors

Constructor and Description
BufferedInput(LinkedList<Line> buffer) Constructor with linked list used as source of the input lines.

Method Summary

Modifier and Type	Method and Description
void	close() Performs a no-op as there are no underlying resources
boolean	hasMoreLines() Returns true if there are more lines to be read.
Line	readLine() Reads the next line.
String	toMultiLineString() Returns a multi-line representation of the lines in this buffer.
String	toString() Returns a list-like representation of the lines contained in this buffer.

Methods inherited from class org.unix4j.io.AbstractInput

iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BufferedInput

public BufferedInput(LinkedList<Line> buffer)

Constructor with linked list used as source of the input lines. The specified buffer is NOT cloned, meaning that changes to the buffer will also be reflected in this input device and vice versa.

Parameters:

buffer - the buffer to use as basis for this input device

Method Detail

hasMoreLines

public boolean hasMoreLines()

Description copied from interface: Input

Returns true if there are more lines to be read.

Returns:

true if more lines exist

readLine

public Line readLine()

Description copied from interface: Input

Reads the next line. Returns null if no next line exists.

Returns:

the next line, or null if no next line exists.

toString

public String toString()

Returns a list-like representation of the lines contained in this buffer. Some users might also consider toMultiLineString() instead.

Overrides:

toString in class Object

Returns:

a list-like string representation of the buffered lines

toMultiLineString

public String toMultiLineString()

Returns a multi-line representation of the lines in this buffer. The last line is never terminated, all other lines are terminated with guarantee even if the line itself has an empty line ending string.

Returns:

a multi-line string of the buffered lines, without line termination for the last line

See Also:

LineUtil.toMultiLineString(List)

close

public void close()

Performs a no-op as there are no underlying resources