WcOption (unix4j 0.7-SNAPSHOT API)

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

All Implemented Interfaces:: Serializable, Comparable<WcOption>, Iterable<WcOption>, Option, OptionSet<WcOption>, WcOptions

public enum WcOption
extends Enum<WcOption>
implements Option, WcOptions

Options for the wc command.

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

`-l`	`--lines`	Executes a count of lines and writes this count to the output.
`-w`	`--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)`.
`-m`	`--chars`	Executes a count of chars and writes this count to the output.

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
`chars` Option `--chars`, `-m`: Executes a count of chars and writes this count to the output.
`lines` Option `--lines`, `-l`: Executes a count of lines and writes this count to the output.
`words` Option `--words`, `-w`: Executes a count of words and writes this count to the output.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`acronym()` Returns a one letter acronym for this option.
`EnumSet<WcOption>`	`asSet()` Returns a new set with `this` active option.
`static WcOption`	`findByAcronym(char acronym)` Returns the option with the given `acronym`, or `null` if no such option is found.
`boolean`	`isSet(WcOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<WcOption>`	`iterator()` Returns an immutable iterator returning o single element: `this` option.
`Class<WcOption>`	`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(WcOption option)` Returns true if the `acronym` should be used for the specified `option` in string representations.
`static WcOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WcOption[]`	`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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Enum Constant Detail
  - lines
```
public static final WcOption lines
```
    Option --lines, -l: Executes a count of lines and writes this count to the output.
  - words
```
public static final WcOption words
```
    Option --words, -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).
  - chars
```
public static final WcOption chars
```
    Option --chars, -m: Executes a count of chars and writes this count to the output.
- Method Detail
  - values
```
public static WcOption[] 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 (WcOption c : WcOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static WcOption 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
  - findByAcronym
```
public static WcOption 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(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
  - asSet
```
public EnumSet<WcOption> asSet()
```
    Returns a new set with this active option.
    
    Specified by:
    
    asSet in interface OptionSet<WcOption>
    
    Returns:
    
    a new set containing this option
  - iterator
```
public Iterator<WcOption> iterator()
```
    Returns an immutable iterator returning o single element: this option.
    
    Specified by:
    
    iterator in interface Iterable<WcOption>
    
    Specified by:
    
    iterator in interface OptionSet<WcOption>
    
    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<WcOption>
    
    Returns:
    
    one
  - useAcronymFor
```
public boolean useAcronymFor(WcOption 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<WcOption>
    
    Parameters:
    
    option - the option of interest
    
    Returns:
    
    always true indicating that option acronyms should be used in string representations for all options

Enum WcOption

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

Methods inherited from interface org.unix4j.option.Option

Methods inherited from interface java.lang.Iterable

Enum Constant Detail

lines

words

chars

Method Detail

values

valueOf

optionType

findByAcronym

acronym

isSet

asSet

iterator

size

useAcronymFor