org.unix4j.io

Class WriterOutput

java.lang.Object

org.unix4j.io.WriterOutput

All Implemented Interfaces:

Output, LineProcessor

Direct Known Subclasses:

FileOutput, StreamOutput, StringOutput

public class WriterOutput
extends java.lang.Object
implements Output

Output device based on a Writer.

Constructor Summary

Constructors

Modifier	Constructor and Description
	WriterOutput(java.io.Writer writer)
protected	WriterOutput(java.io.Writer writer, boolean closeWriterOnFinish)

Method Summary

Modifier and Type	Method and Description
void	finish() Indicates that all output has been written.
protected java.io.Writer	getWriter() Returns the underlying writer that was passed to the constructor.
boolean	processLine(Line line) Writes a line to the output.
protected boolean	writeLastLineEnding() Returns true if the last line ending should be written.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriterOutput

public WriterOutput(java.io.Writer writer)

WriterOutput

protected WriterOutput(java.io.Writer writer,
                       boolean closeWriterOnFinish)

Method Detail

getWriter

protected java.io.Writer getWriter()

Returns the underlying writer that was passed to the constructor.

Returns:

the writer that was passed to the constructor.

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

writeLastLineEnding

protected boolean writeLastLineEnding()

Returns true if the last line ending should be written.

This default implementation always returns true, but certain subclasses such as StringOutput sometimes return false when the last line should not be terminated with a line ending.

Returns:

true if the last line ending should be written, and false otherwise