WcOptionSet_lmw (unix4j 0.4 API)

java.lang.Object
- java.lang.Enum<WcOptionSet_lmw>
- - org.unix4j.unix.wc.WcOptionSet_lmw

All Implemented Interfaces:

Serializable, Comparable<WcOptionSet_lmw>, Iterable<WcOption>, OptionSet<WcOption>, WcOptions
```
public enum WcOptionSet_lmw
extends Enum<WcOptionSet_lmw>
implements WcOptions
```
Option sets for the wc command with the following options: m, l, w.
Application code does normally not directly refer to this class; Wc.Options should be used instead to specify command options. See also WcOptions for more information.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.unix4j.unix.wc.WcOptions
  WcOptions.Default

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Active_l` Option set with the following active options: `l`.
`Active_l_long` Option set with the following active options: `l`.
`Active_lm` Option set with the following active options: `m`, `l`.
`Active_lm_long` Option set with the following active options: `m`, `l`.
`Active_lmw` Option set with the following active options: `m`, `l`, `w`.
`Active_lmw_long` Option set with the following active options: `m`, `l`, `w`.
`Active_lw` Option set with the following active options: `l`, `w`.
`Active_lw_long` Option set with the following active options: `l`, `w`.
`Active_m` Option set with the following active options: `m`.
`Active_m_long` Option set with the following active options: `m`.
`Active_mw` Option set with the following active options: `m`, `w`.
`Active_mw_long` Option set with the following active options: `m`, `w`.
`Active_w` Option set with the following active options: `w`.
`Active_w_long` Option set with the following active options: `w`.

Field Summary

Fields
Modifier and Type	Field and Description
`WcOptionSet_lmw`	`chars` Option `"--chars"`: Executes a count of chars and writes this count to the output.
`WcOptionSet_lmw`	`l` Option `"-l"`: Executes a count of lines and writes this count to the output.
`WcOptionSet_lmw`	`lines` Option `"--lines"`: Executes a count of lines and writes this count to the output.
`WcOptionSet_lmw`	`m` Option `"-m"`: Executes a count of chars and writes this count to the output.
`WcOptionSet_lmw`	`w` Option `"-w"`: Executes a count of words and writes this count to the output.
`WcOptionSet_lmw`	`words` Option `"--words"`: Executes a count of words and writes this count to the output.

Fields inherited from interface org.unix4j.unix.wc.WcOptions
CONVERTER, EMPTY

Method Summary

Methods
Modifier and Type	Method and Description
`EnumSet<WcOption>`	`asSet()` Returns the set with the active options.
`boolean`	`isSet(WcOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<WcOption>`	`iterator()` Returns an immutable iterator with the active options of this option set.
`Class<WcOption>`	`optionType()` Returns the option type class, usually an enum.
`int`	`size()` Returns the number of active options in this option set.
`boolean`	`useAcronymFor(WcOption option)` Returns true if the `acronym` should be used in for the specified `option` string representations.
`static WcOptionSet_lmw`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WcOptionSet_lmw[]`	`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_lmw
```
public static final WcOptionSet_lmw Active_lmw
```
    Option set with the following active options: m, l, w.
  - Active_lmw_long
```
public static final WcOptionSet_lmw Active_lmw_long
```
    Option set with the following active options: m, l, w.
  - Active_lw
```
public static final WcOptionSet_lmw Active_lw
```
    Option set with the following active options: l, w.
  - Active_lw_long
```
public static final WcOptionSet_lmw Active_lw_long
```
    Option set with the following active options: l, w.
  - Active_lm
```
public static final WcOptionSet_lmw Active_lm
```
    Option set with the following active options: m, l.
  - Active_lm_long
```
public static final WcOptionSet_lmw Active_lm_long
```
    Option set with the following active options: m, l.
  - Active_mw
```
public static final WcOptionSet_lmw Active_mw
```
    Option set with the following active options: m, w.
  - Active_mw_long
```
public static final WcOptionSet_lmw Active_mw_long
```
    Option set with the following active options: m, w.
  - Active_l
```
public static final WcOptionSet_lmw Active_l
```
    Option set with the following active options: l.
  - Active_l_long
```
public static final WcOptionSet_lmw Active_l_long
```
    Option set with the following active options: l.
  - Active_w
```
public static final WcOptionSet_lmw Active_w
```
    Option set with the following active options: w.
  - Active_w_long
```
public static final WcOptionSet_lmw Active_w_long
```
    Option set with the following active options: w.
  - Active_m
```
public static final WcOptionSet_lmw Active_m
```
    Option set with the following active options: m.
  - Active_m_long
```
public static final WcOptionSet_lmw Active_m_long
```
    Option set with the following active options: m.
- Field Detail
  - m
```
public final WcOptionSet_lmw m
```
    Option "-m": Executes a count of chars and writes this count to the output.
    The option "-m" is equivalent to the "--chars" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-m". If the option "-m" is already set, the field m points to the enum constant itself as it already represents the current set of options.
  - chars
```
public final WcOptionSet_lmw chars
```
    Option "--chars": Executes a count of chars and writes this count to the output.
    The option "--chars" is equivalent to the "-m" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--chars". If the option "--chars" is already set, the field chars points to the enum constant itself as it already represents the current set of options.
  - l
```
public final WcOptionSet_lmw l
```
    Option "-l": Executes a count of lines and writes this count to the output.
    The option "-l" is equivalent to the "--lines" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-l". If the option "-l" is already set, the field l points to the enum constant itself as it already represents the current set of options.
  - lines
```
public final WcOptionSet_lmw lines
```
    Option "--lines": Executes a count of lines and writes this count to the output.
    The option "--lines" is equivalent to the "-l" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--lines". If the option "--lines" is already set, the field lines points to the enum constant itself as it already represents the current set of options.
  - w
```
public final WcOptionSet_lmw w
```
    Option "-w": Executes a count of words and writes this count to the output. A word is a non-zero-length string of characters delimited by white space as defined by Character.isWhitespace(char).
    The option "-w" is equivalent to the "--words" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-w". If the option "-w" is already set, the field w points to the enum constant itself as it already represents the current set of options.
  - words
```
public final WcOptionSet_lmw words
```
    Option "--words": Executes a count of words and writes this count to the output. A word is a non-zero-length string of characters delimited by white space as defined by Character.isWhitespace(char).
    The option "--words" is equivalent to the "-w" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--words". If the option "--words" is already set, the field words points to the enum constant itself as it already represents the current set of options.
- Method Detail
  - values
```
public static WcOptionSet_lmw[] 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 (WcOptionSet_lmw c : WcOptionSet_lmw.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static WcOptionSet_lmw 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<WcOption> optionType()
```
    Description copied from interface: OptionSet
    
    Returns the option type class, usually an enum.
    
    Specified by:
    
    optionType in interface OptionSet<WcOption>
    
    Returns:
    the option type
  - isSet
```
public boolean isSet(WcOption option)
```
    Description copied from interface: OptionSet
    
    Returns true if the specified option is set and false otherwise
    
    Specified by:
    
    isSet in interface OptionSet<WcOption>
    
    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<WcOption>
    
    Returns:
    the number of active options
  - asSet
```
public EnumSet<WcOption> 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<WcOption>
    
    Returns:
    a copy of the set with the active options.
  - iterator
```
public Iterator<WcOption> iterator()
```
    Returns an immutable iterator with the active options of this option set.
    
    Specified by:
    
    iterator in interface Iterable<WcOption>
    
    Specified by:
    
    iterator in interface OptionSet<WcOption>
    
    Returns:
    an immutable iterator for over the active options
  - useAcronymFor
```
public boolean useAcronymFor(WcOption 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
```
    WcOptionSet_lmw.chars.l;
 
```
    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
```
    WcOptionSet_lmw.m.lines;
 
```
    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:
```
    WcOptionSet_lmw.m.l.chars;
 
```
    This method always returns true for the empty set with no active options.
    Specified by:
    
    useAcronymFor in interface OptionSet<WcOption>
    
    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 WcOptionSet_lmw

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.wc.WcOptions

Enum Constant Summary

Field Summary

Fields inherited from interface org.unix4j.unix.wc.WcOptions

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Active_lmw

Active_lmw_long

Active_lw

Active_lw_long

Active_lm

Active_lm_long

Active_mw

Active_mw_long

Active_l

Active_l_long

Active_w

Active_w_long

Active_m

Active_m_long

Field Detail

m

chars

l

lines

w

words

Method Detail

values

valueOf

optionType

isSet

size

asSet

iterator

useAcronymFor