TailOption (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<TailOption>
- - org.unix4j.unix.tail.TailOption

All Implemented Interfaces:: Serializable, Comparable<TailOption>, Iterable<TailOption>, Option, OptionSet<TailOption>, TailOptions

public enum TailOption
extends Enum<TailOption>
implements Option, TailOptions

Options for the tail command.

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

`-c`	`--chars`	The `count` argument is in units of characters instead of lines. Starts from 1 and includes line ending characters.
`-q`	`--suppressHeaders`	Suppresses printing of headers when multiple files are being examined.
`-s`	`--countFromStart`	The `count` argument is relative to the beginning of the file instead of counting from the end of the file. For instance, `tail -s 10` prints the lines starting from line 10; `tail -s 1` prints the whole file.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.unix4j.unix.tail.TailOptions
  TailOptions.Default

Enum Constant Summary

Enum Constants
Enum Constant and Description
`chars` Option `--chars`, `-c`: The `count` argument is in units of characters instead of lines.
`countFromStart` Option `--countFromStart`, `-s`: The `count` argument is relative to the beginning of the file instead of counting from the end of the file.
`suppressHeaders` Option `--suppressHeaders`, `-q`: Suppresses printing of headers when multiple files are being examined.

Field Summary
- Fields inherited from interface org.unix4j.unix.tail.TailOptions
  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<TailOption>`	`asSet()` Returns a new set with `this` active option.
`static TailOption`	`findByAcronym(char acronym)` Returns the option with the given `acronym`, or `null` if no such option is found.
`boolean`	`isSet(TailOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<TailOption>`	`iterator()` Returns an immutable iterator returning o single element: `this` option.
`Class<TailOption>`	`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(TailOption option)` Returns true if the `acronym` should be used for the specified `option` in string representations.
`static TailOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TailOption[]`	`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
  - chars
```
public static final TailOption chars
```
    Option --chars, -c: The count argument is in units of characters instead of lines. Starts from 1 and includes line ending characters.
  - suppressHeaders
```
public static final TailOption suppressHeaders
```
    Option --suppressHeaders, -q: Suppresses printing of headers when multiple files are being examined.
  - countFromStart
```
public static final TailOption countFromStart
```
    Option --countFromStart, -s: The count argument is relative to the beginning of the file instead of counting from the end of the file. For instance, tail -s 10 prints the lines starting from line 10; tail -s 1 prints the whole file.
- Method Detail
  - values
```
public static TailOption[] 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 (TailOption c : TailOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TailOption 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<TailOption> optionType()
```
    Description copied from interface: OptionSet
    
    Returns the option type class, usually an enum.
    
    Specified by:
    
    optionType in interface OptionSet<TailOption>
    
    Returns:
    
    the option type
  - findByAcronym
```
public static TailOption 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(TailOption option)
```
    Description copied from interface: OptionSet
    
    Returns true if the specified option is set and false otherwise
    
    Specified by:
    
    isSet in interface OptionSet<TailOption>
    
    Parameters:
    
    option - the option to test
    
    Returns:
    
    true if option is set in this OptionSet
  - asSet
```
public EnumSet<TailOption> asSet()
```
    Returns a new set with this active option.
    
    Specified by:
    
    asSet in interface OptionSet<TailOption>
    
    Returns:
    
    a new set containing this option
  - iterator
```
public Iterator<TailOption> iterator()
```
    Returns an immutable iterator returning o single element: this option.
    
    Specified by:
    
    iterator in interface Iterable<TailOption>
    
    Specified by:
    
    iterator in interface OptionSet<TailOption>
    
    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<TailOption>
    
    Returns:
    
    one
  - useAcronymFor
```
public boolean useAcronymFor(TailOption 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<TailOption>
    
    Parameters:
    
    option - the option of interest
    
    Returns:
    
    always true indicating that option acronyms should be used in string representations for all options

Enum TailOption

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.tail.TailOptions

Enum Constant Summary

Field Summary

Fields inherited from interface org.unix4j.unix.tail.TailOptions

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

chars

suppressHeaders

countFromStart

Method Detail

values

valueOf

optionType

findByAcronym

acronym

isSet

asSet

iterator

size

useAcronymFor