org.unix4j.unix.xargs

Enum XargsOption

java.lang.Object

java.lang.Enum<XargsOption>

org.unix4j.unix.xargs.XargsOption

All Implemented Interfaces:

Serializable, Comparable<XargsOption>, Iterable<XargsOption>, Option, OptionSet<XargsOption>, XargsOptions

public enum XargsOption
extends Enum<XargsOption>
implements Option, XargsOptions

Options for the xargs command.

For most applications, it may be more convenient to use Xargs.Options instead of the option constants defined here.

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.xargs.XargsOptions

XargsOptions.Default

Enum Constant Summary

Enum Constants

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

Field Summary

Fields inherited from interface org.unix4j.unix.xargs.XargsOptions

CONVERTER, EMPTY

Method Summary

Methods

Modifier and Type	Method and Description
char	acronym() Returns a one letter acronym for this option.
EnumSet<XargsOption>	asSet() Returns a new set with this active option.
static XargsOption	findByAcronym(char acronym) Returns the option with the given acronym, or null if no such option is found.
boolean	isSet(XargsOption option) Returns true if the specified option is set and false otherwise
Iterator<XargsOption>	iterator() Returns an immutable iterator returning o single element: this option.
Class<XargsOption>	optionType() Returns the option type class, usually an enum.
int	size() Returns 1 as this is a set with a single element: this option
boolean	useAcronymFor(XargsOption option) Returns true if the acronym should be used for the specified option in string representations.
static XargsOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static XargsOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.unix4j.option.Option

name

Enum Constant Detail

delimiter0

public static final XargsOption delimiter0

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

exactArgs

public static final XargsOption exactArgs

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

noRunIfEmpty

public static final XargsOption noRunIfEmpty

Option --noRunIfEmpty, -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.

verbose

public static final XargsOption verbose

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

Method Detail

values

public static XargsOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XargsOption c : XargsOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XargsOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

optionType

public Class<XargsOption> optionType()

Description copied from interface: OptionSet

Returns the option type class, usually an enum.

Specified by:

optionType in interface OptionSet<XargsOption>

Returns:

the option type

findByAcronym

public static XargsOption findByAcronym(char acronym)

Returns the option with the given acronym, or null if no such option is found.

Parameters:

acronym - the option acronym

Returns:

the option with the given acronym or null if it is not found

acronym

public char acronym()

Description copied from interface: Option

Returns a one letter acronym for this option.

Specified by:

acronym in interface Option

Returns:

the acronym character used for this option.

isSet

public boolean isSet(XargsOption option)

Description copied from interface: OptionSet

Returns true if the specified option is set and false otherwise

Specified by:

isSet in interface OptionSet<XargsOption>

Parameters:

option - the option to test

Returns:

true if option is set in this OptionSet

asSet

public EnumSet<XargsOption> asSet()

Returns a new set with this active option.

Specified by:

asSet in interface OptionSet<XargsOption>

Returns:

a new set containing this option

iterator

public Iterator<XargsOption> iterator()

Returns an immutable iterator returning o single element: this option.

Specified by:

iterator in interface Iterable<XargsOption>

Specified by:

iterator in interface OptionSet<XargsOption>

Returns:

an immutable iterator with this active option.

size

public int size()

Returns 1 as this is a set with a single element: this option

Specified by:

size in interface OptionSet<XargsOption>

Returns:

one

useAcronymFor

public boolean useAcronymFor(XargsOption option)

Returns true if the acronym should be used for the specified option in string representations.

This method returns always true for all options.

Specified by:

useAcronymFor in interface OptionSet<XargsOption>

Parameters:

option - the option of interest

Returns:

always true indicating that option acronyms should be used in string representations for all options