org.unix4j.io

Class BufferedOutput

java.lang.Object

org.unix4j.io.BufferedOutput

All Implemented Interfaces:

Output, LineProcessor

public class BufferedOutput
extends Object
implements Output

Output device storing all written lines in memory in a List.

Constructor Summary

Constructors

Constructor and Description
BufferedOutput() Constructor using an ArrayList as backing buffer for the lines.
BufferedOutput(List<Line> buffer) Constructor using the specified list as line buffer.

Method Summary

Modifier and Type	Method and Description
BufferedInput	asInput() Returns a BufferedInput with all lines contained in this BufferedOutput.
List<Line>	asList() Returns a new list with the lines currently stored by this BufferdOutput object.
BufferedOutput	clear() Clears all lines in this buffer.
void	finish() Indicates that all output has been written.
boolean	processLine(Line line) Writes a line to the output.
int	size() Returns the number of lines currently stored by this BufferedOutput object.
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.
void	writeTo(Output output) Writes the buffered output lines to the specified output device.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedOutput

public BufferedOutput()

Constructor using an ArrayList as backing buffer for the lines.

BufferedOutput

public BufferedOutput(List<Line> buffer)

Constructor using the specified list as line buffer. The buffer is NOT cloned, that is, changes to the buffer affect this BufferedOutput and vice versa.

Parameters:

buffer - the line buffer used "as is" without cloning

Method Detail

processLine

public boolean processLine(Line line)

Description copied from interface: Output

Writes a line to the output.

Specified by:

processLine in interface Output

Specified by:

processLine in interface LineProcessor

Parameters:

line - the line to write to the output.

Returns:

true if this Output device is ready to process more lines, and false otherwise; output devices usually return true

finish

public void finish()

Description copied from interface: Output

Indicates that all output has been written. Usually triggers a flush operation or closes the underlying reader or stream.

Specified by:

finish in interface Output

Specified by:

finish in interface LineProcessor

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)

writeTo

public void writeTo(Output output)

Writes the buffered output lines to the specified output device. This buffered output devices does not change, that is, all lines will still be contained in the buffer after calling this method.

Parameters:

output - the output device to write to

asInput

public BufferedInput asInput()

Returns a BufferedInput with all lines contained in this BufferedOutput. The lists used as buffer in this BufferedOutput and the returned BufferedInput are NOT shared, meaning that subsequent modifications of this BufferedOutput are not reflected in the returned BufferedInput.

Returns:

a BufferdInput object reflecting the current snapshot of lines in this BufferedOutput

asList

public List<Line> asList()

Returns a new list with the lines currently stored by this BufferdOutput object.

Returns:

a new list with the lines of this buffer

size

public int size()

Returns the number of lines currently stored by this BufferedOutput object.

Returns:

the number of lines in the buffer

clear

public BufferedOutput clear()

Clears all lines in this buffer.

Returns:

this buffer for chained calls