org.unix4j.command

Interface Arguments<A extends Arguments<A>>

Type Parameters:

A - the concrete command specific arguments type

All Known Implementing Classes:

AdHocCommand.Args, CatArguments, CdArguments, CutArguments, EchoArguments, FindArguments, FromArguments, GrepArguments, HeadArguments, LsArguments, NoOp.Args, SedArguments, SortArguments, TailArguments, UniqArguments, WcArguments, XargsArguments

public interface Arguments<A extends Arguments<A>>

Interface implemented by command arguments. Arguments is usually a container for argument values of different types as well as for option flags. The implementing arguments class is command specific, hence the generic A parameter specified by the concrete command implementation.

Method Summary

Modifier and Type	Method and Description
A	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
String	toString() Returns a string representation of the command arguments and options.

Method Detail

getForContext

A getForContext(ExecutionContext context)

Returns an arguments object for the given execution context with resolved variables if necessary and possible. If variables are defined in this arguments instance, a new arguments instance is created with values instead of variables for those variables that are defined in the specified context object. If this arguments instance uses no variables, this arguments instance is simply returned.

If variables are present, they are resolved if such a variable is defined in the VariableContext returned by context.getVariableContext(). Values are converted if necessary with the ValueConverters returned by context.getValueConverterFor(Class).

Parameters:

context - the execution context providing access to variables and converters

Returns:

an arguments object with resolved variables where possible

Throws:

NullPointerException - if context is null

IllegalArgumentException - if variables are defined but cannot be converted into the target type

toString

String toString()

Returns a string representation of the command arguments and options.

Overrides:

toString in class Object

Returns:

a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"