org.unix4j.unix.xargs

Class XargsOptionSets

java.lang.Object

org.unix4j.unix.xargs.XargsOptionSets

public final class XargsOptionSets
extends Object

Options for the xargs command with the the following options:

	-z		--delimiter0		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).
	-x		--exactArgs		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).
	-r		--noRunIfEmpty		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.
	-t		--verbose		Print the command line on the standard error output before executing it.

This class serves as entry point to every possible set of xargs options defined as an enum constant. With this explicit expansion of all possible option combinations, options can be passed to the command in a very compact form, such as:

 xargs(Xargs.Options.z, ...);
 xargs(Xargs.Options.z.x, ...);
 ...
 xargs(Xargs.Options.z.x.r.t, ...);
 

Field Summary

Fields

Modifier and Type	Field and Description
XargsOptionSet_rtxz	delimiter0 Option "--delimiter0": 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).
XargsOptionSet_rtxz	exactArgs Option "--exactArgs": Terminate immediately if maxArgs is specified but the found number of variable items is less than maxArgs.
static XargsOptionSets	INSTANCE The singleton instance.
XargsOptionSet_rtxz	noRunIfEmpty Option "--noRunIfEmpty": If the standard input does not contain any nonblanks, do not run the command.
XargsOptionSet_rtxz	r Option "-r": If the standard input does not contain any nonblanks, do not run the command.
XargsOptionSet_rtxz	t Option "-t": Print the command line on the standard error output before executing it.
XargsOptionSet_rtxz	verbose Option "--verbose": Print the command line on the standard error output before executing it.
XargsOptionSet_rtxz	x Option "-x": Terminate immediately if maxArgs is specified but the found number of variable items is less than maxArgs.
XargsOptionSet_rtxz	z Option "-z": 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).

Constructor Summary

Constructors

Constructor and Description
XargsOptionSets()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final XargsOptionSets INSTANCE

The singleton instance.

z

public final XargsOptionSet_rtxz z

Option "-z": 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).

The option "-z" is equivalent to the "--delimiter0" option.

delimiter0

public final XargsOptionSet_rtxz delimiter0

Option "--delimiter0": 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).

The option "--delimiter0" is equivalent to the "-z" option.

x

public final XargsOptionSet_rtxz x

Option "-x": 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).

The option "-x" is equivalent to the "--exactArgs" option.

exactArgs

public final XargsOptionSet_rtxz exactArgs

Option "--exactArgs": 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).

The option "--exactArgs" is equivalent to the "-x" option.

r

public final XargsOptionSet_rtxz r

Option "-r": 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.

The option "-r" is equivalent to the "--noRunIfEmpty" option.

noRunIfEmpty

public final XargsOptionSet_rtxz noRunIfEmpty

Option "--noRunIfEmpty": 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.

The option "--noRunIfEmpty" is equivalent to the "-r" option.

t

public final XargsOptionSet_rtxz t

Option "-t": Print the command line on the standard error output before executing it.

The option "-t" is equivalent to the "--verbose" option.

verbose

public final XargsOptionSet_rtxz verbose

Option "--verbose": Print the command line on the standard error output before executing it.

The option "--verbose" is equivalent to the "-t" option.

Constructor Detail

XargsOptionSets

public XargsOptionSets()