CatOptionSet_ns (unix4j 0.4 API)

java.lang.Object
- java.lang.Enum<CatOptionSet_ns>
- - org.unix4j.unix.cat.CatOptionSet_ns

All Implemented Interfaces:

Serializable, Comparable<CatOptionSet_ns>, Iterable<CatOption>, OptionSet<CatOption>, CatOptions
```
public enum CatOptionSet_ns
extends Enum<CatOptionSet_ns>
implements CatOptions
```
Option sets for the cat command with the following options: n, s.
Application code does normally not directly refer to this class; Cat.Options should be used instead to specify command options. See also CatOptions for more information.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.unix4j.unix.cat.CatOptions
  CatOptions.Default

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Active_n` Option set with the following active options: `n`.
`Active_n_long` Option set with the following active options: `n`.
`Active_ns` Option set with the following active options: `n`, `s`.
`Active_ns_long` Option set with the following active options: `n`, `s`.

Field Summary

Fields
Modifier and Type	Field and Description
`CatOptionSet_ns`	`n` Option `"-n"`: Number the output lines, starting at 1.
`CatOptionSet_ns`	`numberLines` Option `"--numberLines"`: Number the output lines, starting at 1.
`CatOptionSet_ns`	`s` Option `"-s"`: Squeeze multiple adjacent empty lines, causing the output to be single spaced.
`CatOptionSet_ns`	`squeezeEmptyLines` Option `"--squeezeEmptyLines"`: Squeeze multiple adjacent empty lines, causing the output to be single spaced.

Fields inherited from interface org.unix4j.unix.cat.CatOptions
CONVERTER, EMPTY

Method Summary

Methods
Modifier and Type	Method and Description
`EnumSet<CatOption>`	`asSet()` Returns the set with the active options.
`boolean`	`isSet(CatOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<CatOption>`	`iterator()` Returns an immutable iterator with the active options of this option set.
`Class<CatOption>`	`optionType()` Returns the option type class, usually an enum.
`int`	`size()` Returns the number of active options in this option set.
`boolean`	`useAcronymFor(CatOption option)` Returns true if the `acronym` should be used in for the specified `option` string representations.
`static CatOptionSet_ns`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CatOptionSet_ns[]`	`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_ns
```
public static final CatOptionSet_ns Active_ns
```
    Option set with the following active options: n, s.
  - Active_ns_long
```
public static final CatOptionSet_ns Active_ns_long
```
    Option set with the following active options: n, s.
  - Active_n
```
public static final CatOptionSet_ns Active_n
```
    Option set with the following active options: n.
  - Active_n_long
```
public static final CatOptionSet_ns Active_n_long
```
    Option set with the following active options: n.
- Field Detail
  - n
```
public final CatOptionSet_ns n
```
    Option "-n": Number the output lines, starting at 1.
    The option "-n" is equivalent to the "--numberLines" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-n". If the option "-n" is already set, the field n points to the enum constant itself as it already represents the current set of options.
  - numberLines
```
public final CatOptionSet_ns numberLines
```
    Option "--numberLines": Number the output lines, starting at 1.
    The option "--numberLines" is equivalent to the "-n" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--numberLines". If the option "--numberLines" is already set, the field numberLines points to the enum constant itself as it already represents the current set of options.
  - s
```
public final CatOptionSet_ns s
```
    Option "-s": Squeeze multiple adjacent empty lines, causing the output to be single spaced.
    The option "-s" is equivalent to the "--squeezeEmptyLines" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-s". If the option "-s" is already set, the field s points to the enum constant itself as it already represents the current set of options.
  - squeezeEmptyLines
```
public final CatOptionSet_ns squeezeEmptyLines
```
    Option "--squeezeEmptyLines": Squeeze multiple adjacent empty lines, causing the output to be single spaced.
    The option "--squeezeEmptyLines" is equivalent to the "-s" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--squeezeEmptyLines". If the option "--squeezeEmptyLines" is already set, the field squeezeEmptyLines points to the enum constant itself as it already represents the current set of options.
- Method Detail
  - values
```
public static CatOptionSet_ns[] 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 (CatOptionSet_ns c : CatOptionSet_ns.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CatOptionSet_ns 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<CatOption> optionType()
```
    Description copied from interface: OptionSet
    
    Returns the option type class, usually an enum.
    
    Specified by:
    
    optionType in interface OptionSet<CatOption>
    
    Returns:
    the option type
  - isSet
```
public boolean isSet(CatOption option)
```
    Description copied from interface: OptionSet
    
    Returns true if the specified option is set and false otherwise
    
    Specified by:
    
    isSet in interface OptionSet<CatOption>
    
    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<CatOption>
    
    Returns:
    the number of active options
  - asSet
```
public EnumSet<CatOption> 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<CatOption>
    
    Returns:
    a copy of the set with the active options.
  - iterator
```
public Iterator<CatOption> iterator()
```
    Returns an immutable iterator with the active options of this option set.
    
    Specified by:
    
    iterator in interface Iterable<CatOption>
    
    Specified by:
    
    iterator in interface OptionSet<CatOption>
    
    Returns:
    an immutable iterator for over the active options
  - useAcronymFor
```
public boolean useAcronymFor(CatOption 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
```
    CatOptionSet_ns.numberLines.s;
 
```
    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
```
    CatOptionSet_ns.n.squeezeEmptyLines;
 
```
    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:
```
    CatOptionSet_ns.n.s.numberLines;
 
```
    This method always returns true for the empty set with no active options.
    Specified by:
    
    useAcronymFor in interface OptionSet<CatOption>
    
    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 CatOptionSet_ns

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.cat.CatOptions

Enum Constant Summary

Field Summary

Fields inherited from interface org.unix4j.unix.cat.CatOptions

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Active_ns

Active_ns_long

Active_n

Active_n_long

Field Detail

n

numberLines

s

squeezeEmptyLines

Method Detail

values

valueOf

optionType

isSet

size

asSet

iterator

useAcronymFor