org.unix4j.operation

Class AdHocCommand

java.lang.Object

org.unix4j.command.AbstractCommand<AdHocCommand.Args>

org.unix4j.operation.AdHocCommand

All Implemented Interfaces:

Command<AdHocCommand.Args>

public class AdHocCommand
extends AbstractCommand<AdHocCommand.Args>

Implementation of an ad-hoc command based on a LineOperation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdHocCommand.Args Arguments for AdHocCommand.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The "adhoc" name for this command.

Constructor Summary

Constructors

Constructor and Description
AdHocCommand(LineOperation operation)

Method Summary

Methods

Modifier and Type	Method and Description
LineProcessor	execute(ExecutionContext context, LineProcessor output) Executes this command and returns a LineProcessor object.

Methods inherited from class org.unix4j.command.AbstractCommand

getArguments, getName, join, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The "adhoc" name for this command.

See Also:

Constant Field Values

Constructor Detail

AdHocCommand

public AdHocCommand(LineOperation operation)

Method Detail

execute

public LineProcessor execute(ExecutionContext context,
                    LineProcessor output)

Description copied from interface: Command

Executes this command and returns a LineProcessor object. Calling this method initiates the command execution, but the real processing of the command takes place when lines are passed to the returned LineProcessor object. The command execution is terminated by calling LineProcessor.finish().

The command writes its output to the specified output object. Depending on the command implementation, the output is written when lines are passed to the LineProcessor returned by this method, or when the execution terminates with the finish() call.

Parameters:

context - context object providing access to the current directory, environment variables and other information useful for the command during its execution

output - the output to write to

Returns:

true if another invocation with more input is expected, and false if this command has completed and no other invocation is required.