org.unix4j.unix.xargs

Class XargsLineProcessor

java.lang.Object

org.unix4j.processor.AbstractLineProcessor<XargsArguments>

org.unix4j.unix.xargs.XargsLineProcessor

All Implemented Interfaces:

LineProcessor

 class XargsLineProcessor
extends AbstractLineProcessor<XargsArguments>

Constructor Summary

Constructors

Constructor and Description
XargsLineProcessor(XargsCommand command, ExecutionContext context, LineProcessor output)

Method Summary

Methods

Modifier and Type	Method and Description
void	finish() Indicates that this line processing task is complete and can finished.
protected XargsArguments	getArguments() Returns the command arguments for the current variable context.
protected XargsCommand	getCommand() Returns the command that was passed to the constructor of this line processor, the command whose execute method usually returns this line processor.
protected XargsOutput	getOutput() Returns the output that was passed to the constructor of this line processor, the object to write to when executing the command through the this processor
protected VariableContext	getVariableContext()
protected void	invoke()
boolean	processLine(Line line) Processes a single line and returns true if this LineProcessor is ready to process more lines.

Methods inherited from class org.unix4j.processor.AbstractLineProcessor

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

XargsLineProcessor

public XargsLineProcessor(XargsCommand command,
                  ExecutionContext context,
                  LineProcessor output)

Method Detail

getCommand

protected XargsCommand getCommand()

Description copied from class: AbstractLineProcessor

Returns the command that was passed to the constructor of this line processor, the command whose execute method usually returns this line processor.

Overrides:

getCommand in class AbstractLineProcessor<XargsArguments>

Returns:

the command whose execute method usually returns this line processor

getArguments

protected XargsArguments getArguments()

Description copied from class: AbstractLineProcessor

Returns the command arguments for the current variable context. This method returns and caches the result of
getCommand().getArguments(getContext()).

Overrides:

getArguments in class AbstractLineProcessor<XargsArguments>

Returns:

the command arguments for the current variable context

getOutput

protected XargsOutput getOutput()

Description copied from class: AbstractLineProcessor

Returns the output that was passed to the constructor of this line processor, the object to write to when executing the command through the this processor

Overrides:

getOutput in class AbstractLineProcessor<XargsArguments>

Returns:

the output to write to when using this processor

getVariableContext

protected VariableContext getVariableContext()

invoke

protected void invoke()

processLine

public boolean processLine(Line line)

Description copied from interface: LineProcessor

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

public void finish()

Description copied from interface: LineProcessor

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.