org.unix4j.processor

Interface LineProcessor

All Known Subinterfaces:

Output

All Known Implementing Classes:

AbstractGrepProcessor, AbstractHeadProcessor, AbstractLineProcessor, AbstractRegexpProcessor, AbstractSedProcessor, AbstractSortProcessor, AbstractTailProcessor, AbstractTextProcessor, AdjacentProcessor, AdjacentProcessor.Count, AdjacentProcessor.DuplicateOnly, AdjacentProcessor.Normal, AdjacentProcessor.UniqueDuplicateCount, AdjacentProcessor.UniqueOnly, AppendProcessor, BufferedOutput, CatProcessor, ChangeProcessor, CheckProcessor, CountMatchingLinesProcessor, DeleteProcessor, FileOutput, GlobalProcessor, GlobalProcessor.Count, GlobalProcessor.DuplicateOnly, GlobalProcessor.Normal, GlobalProcessor.UniqueDuplicateCount, GlobalProcessor.UniqueOnly, HeadCharsProcessor, HeadLinesProcessor, InputLineProcessor, InsertProcessor, MergeProcessor, MultipleInputLineProcessor, NullOutput, NumberLinesProcessor, PrintProcessor, RedirectInputLineProcessor, SortProcessor, SqueezeEmptyLinesProcessor, StdOutput, StreamOutput, StringOutput, SubstituteProcessor, TailCharsFromEndProcessor, TailCharsFromStartProcessor, TailLinesFromEndProcessor, TailLinesFromStartProcessor, TranslateProcessor, UniqProcessor, UniqueSortProcessor, WcMultipleFilesProcessor, WcProcessor, WriteFilesWithMatchingLinesProcessor, WriteMatchingLinesProcessor, WriterOutput, XargsLineProcessor, XargsOutput

public interface LineProcessor

A LineProcessor is a program or device that processes line based data.

An simple example of a LineProcessor is an output device that writes the lines to a file; another more sophisticated LineProcessor performs algorithmic operations based on the line input, for instance a command that counts the lines and writes only the line count to the destination file or stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	finish() Indicates that this line processing task is complete and can finished.
boolean	processLine(Line line) Processes a single line and returns true if this LineProcessor is ready to process more lines.

Method Detail

processLine

boolean processLine(Line line)

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

Parameters:

line - the line to process

Returns:

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

finish

void finish()

Indicates that this line processing task is complete 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.