org.unix4j.unix.xargs

Class XargsArguments

java.lang.Object

org.unix4j.unix.xargs.XargsArguments

All Implemented Interfaces:

Arguments<XargsArguments>

public final class XargsArguments
extends Object
implements Arguments<XargsArguments>

Arguments and options for the xargs command.

Constructor Summary

Constructors

Constructor and Description
XargsArguments() Constructor to use if no options are specified.
XargsArguments(String... args) Constructor string arguments encoding options and arguments, possibly also containing variable expressions.
XargsArguments(XargsOptions options) Constructor with option set containing the selected command options.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getArgs() Returns the <args> operand value: String arguments defining the options and operands for the command.
String	getDelimiter() Returns the <delimiter> operand value (variables are NOT resolved): Input items are terminated by the specified characters.
String	getDelimiter(ExecutionContext context) Returns the <delimiter> (variables are resolved): Input items are terminated by the specified characters.
String	getEof() Returns the <eof> operand value (variables are NOT resolved): If the end of file string occurs as a line of input, the rest of the input is ignored.
String	getEof(ExecutionContext context) Returns the <eof> (variables are resolved): If the end of file string occurs as a line of input, the rest of the input is ignored.
XargsArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
int	getMaxArgs() Returns the <maxArgs> operand value: Use at most maxArgs arguments per command invocation.
long	getMaxLines() Returns the <maxLines> operand value: Use at most maxLines nonblank input lines per command invocation.
XargsOptions	getOptions() Returns the options set containing the selected command options.
boolean	isArgsSet() Returns true if the <args> operand has been set.
boolean	isDelimiter0() Returns true if the --delimiter0 option is set.
boolean	isDelimiterSet() Returns true if the <delimiter> operand has been set.
boolean	isEofSet() Returns true if the <eof> operand has been set.
boolean	isExactArgs() Returns true if the --exactArgs option is set.
boolean	isMaxArgsSet() Returns true if the <maxArgs> operand has been set.
boolean	isMaxLinesSet() Returns true if the <maxLines> operand has been set.
boolean	isNoRunIfEmpty() Returns true if the --noRunIfEmpty option is set.
boolean	isVerbose() Returns true if the --verbose option is set.
void	setDelimiter(String delimiter) Sets <delimiter>: Input items are terminated by the specified characters.
void	setEof(String eof) Sets <eof>: If the end of file string occurs as a line of input, the rest of the input is ignored.
void	setMaxArgs(int maxArgs) Sets <maxArgs>: Use at most maxArgs arguments per command invocation.
void	setMaxLines(long maxLines) Sets <maxLines>: Use at most maxLines nonblank input lines per command invocation.
String	toString() Returns a string representation of the command arguments and options.

Methods inherited from class java.lang.Object

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

Constructor Detail

XargsArguments

public XargsArguments()

Constructor to use if no options are specified.

XargsArguments

public XargsArguments(XargsOptions options)

Constructor with option set containing the selected command options.

Parameters:

options - the selected options

Throws:

NullPointerException - if the argument is null

XargsArguments

public XargsArguments(String... args)

Constructor string arguments encoding options and arguments, possibly also containing variable expressions.

Parameters:

args - string arguments for the command

Throws:

NullPointerException - if args is null

Method Detail

getOptions

public XargsOptions getOptions()

Returns the options set containing the selected command options. Returns an empty options set if no option has been selected.

Returns:

set with the selected options

getForContext

public XargsArguments getForContext(ExecutionContext context)

Description copied from interface: Arguments

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).

Specified by:

getForContext in interface Arguments<XargsArguments>

Parameters:

context - the execution context providing access to variables and converters

Returns:

an arguments object with resolved variables where possible

getDelimiter

public String getDelimiter()

Returns the <delimiter> operand value (variables are NOT resolved): Input items are terminated by the specified characters.

Returns:

the <delimiter> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

See Also:

getDelimiter(ExecutionContext)

getDelimiter

public String getDelimiter(ExecutionContext context)

Returns the <delimiter> (variables are resolved): Input items are terminated by the specified characters.

Parameters:

context - the execution context used to resolve variables

Returns:

the <delimiter> operand value after resolving variables

Throws:

IllegalStateException - if this operand has never been set

See Also:

getDelimiter()

isDelimiterSet

public boolean isDelimiterSet()

Returns true if the <delimiter> operand has been set.

Note that this method returns true even if null was passed to the setDelimiter(String) method.

Returns:

true if the setter for the <delimiter> operand has been called at least once

setDelimiter

public void setDelimiter(String delimiter)

Sets <delimiter>: Input items are terminated by the specified characters.

Parameters:

delimiter - the value for the <delimiter> operand

getEof

public String getEof()

Returns the <eof> operand value (variables are NOT resolved): If the end of file string occurs as a line of input, the rest of the input is ignored.

Returns:

the <eof> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

See Also:

getEof(ExecutionContext)

getEof

public String getEof(ExecutionContext context)

Returns the <eof> (variables are resolved): If the end of file string occurs as a line of input, the rest of the input is ignored.

Parameters:

context - the execution context used to resolve variables

Returns:

the <eof> operand value after resolving variables

Throws:

IllegalStateException - if this operand has never been set

See Also:

getEof()

isEofSet

public boolean isEofSet()

Returns true if the <eof> operand has been set.

Note that this method returns true even if null was passed to the setEof(String) method.

Returns:

true if the setter for the <eof> operand has been called at least once

setEof

public void setEof(String eof)

Sets <eof>: If the end of file string occurs as a line of input, the rest of the input is ignored.

Parameters:

eof - the value for the <eof> operand

getMaxLines

public long getMaxLines()

Returns the <maxLines> operand value: Use at most maxLines nonblank input lines per command invocation.

Returns:

the <maxLines> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isMaxLinesSet

public boolean isMaxLinesSet()

Returns true if the <maxLines> operand has been set.

Note that this method returns true even if null was passed to the setMaxLines(long) method.

Returns:

true if the setter for the <maxLines> operand has been called at least once

setMaxLines

public void setMaxLines(long maxLines)

Sets <maxLines>: Use at most maxLines nonblank input lines per command invocation.

Parameters:

maxLines - the value for the <maxLines> operand

getMaxArgs

public int getMaxArgs()

Returns the <maxArgs> operand value: Use at most maxArgs arguments per command invocation.

Returns:

the <maxArgs> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isMaxArgsSet

public boolean isMaxArgsSet()

Returns true if the <maxArgs> operand has been set.

Note that this method returns true even if null was passed to the setMaxArgs(int) method.

Returns:

true if the setter for the <maxArgs> operand has been called at least once

setMaxArgs

public void setMaxArgs(int maxArgs)

Sets <maxArgs>: Use at most maxArgs arguments per command invocation.

Parameters:

maxArgs - the value for the <maxArgs> operand

getArgs

public String[] getArgs()

Returns the <args> operand value: String arguments defining the options and operands for the command. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). Operands other than the default "--maxArgs" operand have to be prefixed with the operand name (e.g. "--maxLines" for a subsequent line count operand value).

Returns:

the <args> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isArgsSet

public boolean isArgsSet()

Returns true if the <args> operand has been set.

Returns:

true if the setter for the <args> operand has been called at least once

isDelimiter0

public boolean isDelimiter0()

Returns true if the --delimiter0 option is set. The option is also known as -z option.

Description: Input items are terminated by a null character instead of by whitespace, and the quotes and backslash are not special (every character is taken literally). Disables the end of file string, which is treated like any other argument. Useful when input items might contain white space, quote marks, or backslashes. The find --print0 option produces input suitable for this mode.

(This option is ignored if an explicit delimiter operand is specified).

Returns:

true if the --delimiter0 or -z option is set

isExactArgs

public boolean isExactArgs()

Returns true if the --exactArgs option is set. The option is also known as -x option.

Description: Terminate immediately if maxArgs is specified but the found number of variable items is less than maxArgs.

(This option is ignored if no maxArgs operand is specified).

Returns:

true if the --exactArgs or -x option is set

isNoRunIfEmpty

public boolean isNoRunIfEmpty()

Returns true if the --noRunIfEmpty option is set. The option is also known as -r option.

Description: If the standard input does not contain any nonblanks, do not run the command. Normally, the command is run once even if there is no input.

Returns:

true if the --noRunIfEmpty or -r option is set

isVerbose

public boolean isVerbose()

Returns true if the --verbose option is set. The option is also known as -t option.

Description: Print the command line on the standard error output before executing it.

Returns:

true if the --verbose or -t option is set

toString

public String toString()

Description copied from interface: Arguments

Returns a string representation of the command arguments and options.

Specified by:

toString in interface Arguments<XargsArguments>

Overrides:

toString in class Object

Returns:

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