org.unix4j.processor

Class DefaultInputProcessor

java.lang.Object

org.unix4j.processor.DefaultInputProcessor

All Implemented Interfaces:

InputProcessor

Direct Known Subclasses:

CountMatchingLinesProcessor, WcFileProcessor, WriteFilesWithMatchingLinesProcessor

public class DefaultInputProcessor
extends Object
implements InputProcessor

The DefaultInputProcessor simply writes every line passed to processLine(Input, Line, LineProcessor) to the output. Subclasses often override some of the methods to enhance or modify this default behavior.

Constructor Summary

Constructors

Constructor and Description
DefaultInputProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	begin(Input input, LineProcessor output) Indicates that the line processing task is about to start for the specified input device.
void	finish(Input input, LineProcessor output) Indicates that this line processing task is complete for the specified input device and can finished.
boolean	processLine(Input input, Line line, LineProcessor output) Processes a single line and returns true if this InputProcessor is ready to process more lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInputProcessor

public DefaultInputProcessor()

Method Detail

begin

public void begin(Input input,
         LineProcessor output)

Description copied from interface: InputProcessor

Indicates that the line processing task is about to start for the specified input device.

Specified by:

begin in interface InputProcessor

Parameters:

input - the input device whose lines are about to be processed next

output - the output to write to

processLine

public boolean processLine(Input input,
                  Line line,
                  LineProcessor output)

Description copied from interface: InputProcessor

Processes a single line and returns true if this InputProcessor is ready to process more lines. Returning false indicates that the process can be finished because subsequent lines would not change the result anyway.

Specified by:

processLine in interface InputProcessor

Parameters:

input - the input device, the source of the given line

line - the line to process

output - the output to write to

Returns:

true if this InputProcessor is ready to process more lines, and false if it does not require any more input lines

finish

public void finish(Input input,
          LineProcessor output)

Description copied from interface: InputProcessor

Indicates that this line processing task is complete for the specified input device and can finished.

Simple output devices usually perform a flush operation in this method. More complex commands may perform the real operation in this method, for instance write the total count of lines or words to the target file or stream.

Specified by:

finish in interface InputProcessor

Parameters:

input - the input device whose lines have now all been processed

output - the output to write to