XargsOptionSet_rtxz (unix4j 0.4 API)

java.lang.Object
- java.lang.Enum<XargsOptionSet_rtxz>
- - org.unix4j.unix.xargs.XargsOptionSet_rtxz

All Implemented Interfaces:

Serializable, Comparable<XargsOptionSet_rtxz>, Iterable<XargsOption>, OptionSet<XargsOption>, XargsOptions
```
public enum XargsOptionSet_rtxz
extends Enum<XargsOptionSet_rtxz>
implements XargsOptions
```
Option sets for the xargs command with the following options: z, x, r, t.
Application code does normally not directly refer to this class; Xargs.Options should be used instead to specify command options. See also XargsOptions for more information.

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
`Active_r` Option set with the following active options: `r`.
`Active_r_long` Option set with the following active options: `r`.
`Active_rt` Option set with the following active options: `r`, `t`.
`Active_rt_long` Option set with the following active options: `r`, `t`.
`Active_rtx` Option set with the following active options: `x`, `r`, `t`.
`Active_rtx_long` Option set with the following active options: `x`, `r`, `t`.
`Active_rtxz` Option set with the following active options: `z`, `x`, `r`, `t`.
`Active_rtxz_long` Option set with the following active options: `z`, `x`, `r`, `t`.
`Active_rtz` Option set with the following active options: `z`, `r`, `t`.
`Active_rtz_long` Option set with the following active options: `z`, `r`, `t`.
`Active_rx` Option set with the following active options: `x`, `r`.
`Active_rx_long` Option set with the following active options: `x`, `r`.
`Active_rxz` Option set with the following active options: `z`, `x`, `r`.
`Active_rxz_long` Option set with the following active options: `z`, `x`, `r`.
`Active_rz` Option set with the following active options: `z`, `r`.
`Active_rz_long` Option set with the following active options: `z`, `r`.
`Active_t` Option set with the following active options: `t`.
`Active_t_long` Option set with the following active options: `t`.
`Active_tx` Option set with the following active options: `x`, `t`.
`Active_tx_long` Option set with the following active options: `x`, `t`.
`Active_txz` Option set with the following active options: `z`, `x`, `t`.
`Active_txz_long` Option set with the following active options: `z`, `x`, `t`.
`Active_tz` Option set with the following active options: `z`, `t`.
`Active_tz_long` Option set with the following active options: `z`, `t`.
`Active_x` Option set with the following active options: `x`.
`Active_x_long` Option set with the following active options: `x`.
`Active_xz` Option set with the following active options: `z`, `x`.
`Active_xz_long` Option set with the following active options: `z`, `x`.
`Active_z` Option set with the following active options: `z`.
`Active_z_long` Option set with the following active options: `z`.

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

Fields inherited from interface org.unix4j.unix.xargs.XargsOptions
CONVERTER, EMPTY

Method Summary

Methods
Modifier and Type	Method and Description
`EnumSet<XargsOption>`	`asSet()` Returns the set with the active options.
`boolean`	`isSet(XargsOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<XargsOption>`	`iterator()` Returns an immutable iterator with the active options of this option set.
`Class<XargsOption>`	`optionType()` Returns the option type class, usually an enum.
`int`	`size()` Returns the number of active options in this option set.
`boolean`	`useAcronymFor(XargsOption option)` Returns true if the `acronym` should be used in for the specified `option` string representations.
`static XargsOptionSet_rtxz`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static XargsOptionSet_rtxz[]`	`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

- Enum Constant Detail
  - Active_rtxz
```
public static final XargsOptionSet_rtxz Active_rtxz
```
    Option set with the following active options: z, x, r, t.
  - Active_rtxz_long
```
public static final XargsOptionSet_rtxz Active_rtxz_long
```
    Option set with the following active options: z, x, r, t.
  - Active_rxz
```
public static final XargsOptionSet_rtxz Active_rxz
```
    Option set with the following active options: z, x, r.
  - Active_rxz_long
```
public static final XargsOptionSet_rtxz Active_rxz_long
```
    Option set with the following active options: z, x, r.
  - Active_txz
```
public static final XargsOptionSet_rtxz Active_txz
```
    Option set with the following active options: z, x, t.
  - Active_txz_long
```
public static final XargsOptionSet_rtxz Active_txz_long
```
    Option set with the following active options: z, x, t.
  - Active_rtz
```
public static final XargsOptionSet_rtxz Active_rtz
```
    Option set with the following active options: z, r, t.
  - Active_rtz_long
```
public static final XargsOptionSet_rtxz Active_rtz_long
```
    Option set with the following active options: z, r, t.
  - Active_rtx
```
public static final XargsOptionSet_rtxz Active_rtx
```
    Option set with the following active options: x, r, t.
  - Active_rtx_long
```
public static final XargsOptionSet_rtxz Active_rtx_long
```
    Option set with the following active options: x, r, t.
  - Active_xz
```
public static final XargsOptionSet_rtxz Active_xz
```
    Option set with the following active options: z, x.
  - Active_xz_long
```
public static final XargsOptionSet_rtxz Active_xz_long
```
    Option set with the following active options: z, x.
  - Active_rz
```
public static final XargsOptionSet_rtxz Active_rz
```
    Option set with the following active options: z, r.
  - Active_rz_long
```
public static final XargsOptionSet_rtxz Active_rz_long
```
    Option set with the following active options: z, r.
  - Active_tz
```
public static final XargsOptionSet_rtxz Active_tz
```
    Option set with the following active options: z, t.
  - Active_tz_long
```
public static final XargsOptionSet_rtxz Active_tz_long
```
    Option set with the following active options: z, t.
  - Active_rx
```
public static final XargsOptionSet_rtxz Active_rx
```
    Option set with the following active options: x, r.
  - Active_rx_long
```
public static final XargsOptionSet_rtxz Active_rx_long
```
    Option set with the following active options: x, r.
  - Active_tx
```
public static final XargsOptionSet_rtxz Active_tx
```
    Option set with the following active options: x, t.
  - Active_tx_long
```
public static final XargsOptionSet_rtxz Active_tx_long
```
    Option set with the following active options: x, t.
  - Active_rt
```
public static final XargsOptionSet_rtxz Active_rt
```
    Option set with the following active options: r, t.
  - Active_rt_long
```
public static final XargsOptionSet_rtxz Active_rt_long
```
    Option set with the following active options: r, t.
  - Active_z
```
public static final XargsOptionSet_rtxz Active_z
```
    Option set with the following active options: z.
  - Active_z_long
```
public static final XargsOptionSet_rtxz Active_z_long
```
    Option set with the following active options: z.
  - Active_x
```
public static final XargsOptionSet_rtxz Active_x
```
    Option set with the following active options: x.
  - Active_x_long
```
public static final XargsOptionSet_rtxz Active_x_long
```
    Option set with the following active options: x.
  - Active_r
```
public static final XargsOptionSet_rtxz Active_r
```
    Option set with the following active options: r.
  - Active_r_long
```
public static final XargsOptionSet_rtxz Active_r_long
```
    Option set with the following active options: r.
  - Active_t
```
public static final XargsOptionSet_rtxz Active_t
```
    Option set with the following active options: t.
  - Active_t_long
```
public static final XargsOptionSet_rtxz Active_t_long
```
    Option set with the following active options: t.
- Field Detail
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "-z". If the option "-z" is already set, the field z points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "--delimiter0". If the option "--delimiter0" is already set, the field delimiter0 points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "-x". If the option "-x" is already set, the field x points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "--exactArgs". If the option "--exactArgs" is already set, the field exactArgs points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "-r". If the option "-r" is already set, the field r points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "--noRunIfEmpty". If the option "--noRunIfEmpty" is already set, the field noRunIfEmpty points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "-t". If the option "-t" is already set, the field t points to the enum constant itself as it already represents the current set of options.
  - 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.
    Technically speaking, this field points to a set with the options of the current set plus the option "--verbose". If the option "--verbose" is already set, the field verbose points to the enum constant itself as it already represents the current set of options.
- Method Detail
  - values
```
public static XargsOptionSet_rtxz[] 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 (XargsOptionSet_rtxz c : XargsOptionSet_rtxz.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static XargsOptionSet_rtxz 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
  - 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
  - size
```
public int size()
```
    Description copied from interface: OptionSet
    
    Returns the number of active options in this option set.
    
    Specified by:
    
    size in interface OptionSet<XargsOption>
    
    Returns:
    the number of active options
  - asSet
```
public EnumSet<XargsOption> asSet()
```
    Returns the set with the active options. The returned set a new defensive copy instance created when this method is called, modifications of this set will therefore not alter this option set.
    
    Specified by:
    
    asSet in interface OptionSet<XargsOption>
    
    Returns:
    a copy of the set with the active options.
  - iterator
```
public Iterator<XargsOption> iterator()
```
    Returns an immutable iterator with the active options of this option set.
    
    Specified by:
    
    iterator in interface Iterable<XargsOption>
    
    Specified by:
    
    iterator in interface OptionSet<XargsOption>
    
    Returns:
    an immutable iterator for over the active options
  - useAcronymFor
```
public boolean useAcronymFor(XargsOption option)
```
    Returns true if the acronym should be used in for the specified option string representations.
    In particular and independent from the option argument, this option set returns true if the last option added to this set was an acronym, and false if it was a long option name.
    For instance, the set defined as
```
    XargsOptionSet_rtxz.delimiter0.x;
 
```
    uses acronyms, that is, this method always returns true for the above set.
    On the other hand, long option names are used and this method always returns false for the set
```
    XargsOptionSet_rtxz.z.exactArgs;
 
```
    Note that a repeated option is not treated as the last set option. For instance, the first and last option of the following set are equivalent and acronyms are used:
```
    XargsOptionSet_rtxz.z.x.delimiter0;
 
```
    This method always returns true for the empty set with no active options.
    Specified by:
    
    useAcronymFor in interface OptionSet<XargsOption>
    
    Parameters:
    option - the option of interest, has no impact on the result returned by this method
    
    Returns:
    true if option acronyms should be used for string representations of any option of this option set

Enum XargsOptionSet_rtxz

Nested Class Summary

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

Enum Constant Summary

Field Summary

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

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Active_rtxz

Active_rtxz_long

Active_rxz

Active_rxz_long

Active_txz

Active_txz_long

Active_rtz

Active_rtz_long

Active_rtx

Active_rtx_long

Active_xz

Active_xz_long

Active_rz

Active_rz_long

Active_tz

Active_tz_long

Active_rx

Active_rx_long

Active_tx

Active_tx_long

Active_rt

Active_rt_long

Active_z

Active_z_long

Active_x

Active_x_long

Active_r

Active_r_long

Active_t

Active_t_long

Field Detail

z

delimiter0

x

exactArgs

r

noRunIfEmpty

t

verbose

Method Detail

values

valueOf

optionType

isSet

size

asSet

iterator

useAcronymFor