GrepOption (unix4j 0.4 API)

java.lang.Object
- java.lang.Enum<GrepOption>
- - org.unix4j.unix.grep.GrepOption

All Implemented Interfaces:: Serializable, Comparable<GrepOption>, Iterable<GrepOption>, Option, OptionSet<GrepOption>, GrepOptions

public enum GrepOption
extends Enum<GrepOption>
implements Option, GrepOptions

Options for the grep command.

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

`-i`	`--ignoreCase`	Match lines ignoring the case when comparing the strings, also known from Unix with its acronym 'i'.
`-v`	`--invertMatch`	Invert the match result, that is, a non-matching line is written to the output and a matching line is not. This option is also known from Unix with its acronym 'v'.
`-F`	`--fixedStrings`	Use fixed-strings matching instead of regular expressions. This is usually faster than the standard regexp version. (This option is ignored if a `pattern` operand is specified instead of the `regexp` string).
`-n`	`--lineNumber`	Prefix each line of output with the line number within its input file.
`-c`	`--count`	Suppress normal output; instead print a count of matching lines for each input file. With the `-v`, `--invertMatch` option, count non-matching lines.
`-l`	`--matchingFiles`	Suppress normal output; instead print the name of each input file from which output would normally have been printed. The scanning will stop on the first match.
`-x`	`--wholeLine`	Select only those matches that exactly match the whole line excluding the terminating line ending. (This option is ignored if a `pattern` operand is specified instead of the `regexp` string).

Nested Class Summary
- Nested classes/interfaces inherited from interface org.unix4j.unix.grep.GrepOptions
  GrepOptions.Default

Enum Constant Summary

Enum Constants
Enum Constant and Description
`count` Option `--count`, `-c`: Suppress normal output; instead print a count of matching lines for each input file.
`fixedStrings` Option `--fixedStrings`, `-F`: Use fixed-strings matching instead of regular expressions.
`ignoreCase` Option `--ignoreCase`, `-i`: Match lines ignoring the case when comparing the strings, also known from Unix with its acronym 'i'.
`invertMatch` Option `--invertMatch`, `-v`: Invert the match result, that is, a non-matching line is written to the output and a matching line is not.
`lineNumber` Option `--lineNumber`, `-n`: Prefix each line of output with the line number within its input file.
`matchingFiles` Option `--matchingFiles`, `-l`: Suppress normal output; instead print the name of each input file from which output would normally have been printed.
`wholeLine` Option `--wholeLine`, `-x`: Select only those matches that exactly match the whole line excluding the terminating line ending.

Field Summary
- Fields inherited from interface org.unix4j.unix.grep.GrepOptions
  CONVERTER, EMPTY

Method Summary

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

- Enum Constant Detail
  - ignoreCase
```
public static final GrepOption ignoreCase
```
    Option --ignoreCase, -i: Match lines ignoring the case when comparing the strings, also known from Unix with its acronym 'i'.
  - invertMatch
```
public static final GrepOption invertMatch
```
    Option --invertMatch, -v: Invert the match result, that is, a non-matching line is written to the output and a matching line is not. This option is also known from Unix with its acronym 'v'.
  - fixedStrings
```
public static final GrepOption fixedStrings
```
    Option --fixedStrings, -F: Use fixed-strings matching instead of regular expressions. This is usually faster than the standard regexp version.
    (This option is ignored if a pattern operand is specified instead of the regexp string).
  - lineNumber
```
public static final GrepOption lineNumber
```
    Option --lineNumber, -n: Prefix each line of output with the line number within its input file.
  - count
```
public static final GrepOption count
```
    Option --count, -c: Suppress normal output; instead print a count of matching lines for each input file. With the -v, --invertMatch option, count non-matching lines.
  - matchingFiles
```
public static final GrepOption matchingFiles
```
    Option --matchingFiles, -l: Suppress normal output; instead print the name of each input file from which output would normally have been printed. The scanning will stop on the first match.
  - wholeLine
```
public static final GrepOption wholeLine
```
    Option --wholeLine, -x: Select only those matches that exactly match the whole line excluding the terminating line ending.
    (This option is ignored if a pattern operand is specified instead of the regexp string).
- Method Detail
  - values
```
public static GrepOption[] 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 (GrepOption c : GrepOption.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GrepOption 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<GrepOption> optionType()
```
    Description copied from interface: OptionSet
    
    Returns the option type class, usually an enum.
    
    Specified by:
    
    optionType in interface OptionSet<GrepOption>
    
    Returns:
    the option type
  - findByAcronym
```
public static GrepOption 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(GrepOption option)
```
    Description copied from interface: OptionSet
    
    Returns true if the specified option is set and false otherwise
    
    Specified by:
    
    isSet in interface OptionSet<GrepOption>
    
    Parameters:
    option - the option to test
    
    Returns:
    true if option is set in this OptionSet
  - asSet
```
public EnumSet<GrepOption> asSet()
```
    Returns a new set with this active option.
    
    Specified by:
    
    asSet in interface OptionSet<GrepOption>
    
    Returns:
    a new set containing this option
  - iterator
```
public Iterator<GrepOption> iterator()
```
    Returns an immutable iterator returning o single element: this option.
    
    Specified by:
    
    iterator in interface Iterable<GrepOption>
    
    Specified by:
    
    iterator in interface OptionSet<GrepOption>
    
    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<GrepOption>
    
    Returns:
    one
  - useAcronymFor
```
public boolean useAcronymFor(GrepOption 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<GrepOption>
    
    Parameters:
    option - the option of interest
    
    Returns:
    always true indicating that option acronyms should be used in string representations for all options

Enum GrepOption

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.grep.GrepOptions

Enum Constant Summary

Field Summary

Fields inherited from interface org.unix4j.unix.grep.GrepOptions

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.unix4j.option.Option

Enum Constant Detail

ignoreCase

invertMatch

fixedStrings

lineNumber

count

matchingFiles

wholeLine

Method Detail

values

valueOf

optionType

findByAcronym

acronym

isSet

asSet

iterator

size

useAcronymFor