SedOption (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<SedOption>
- - org.unix4j.unix.sed.SedOption

All Implemented Interfaces:: Serializable, Comparable<SedOption>, Iterable<SedOption>, Option, OptionSet<SedOption>, SedOptions

public enum SedOption
extends Enum<SedOption>
implements Option, SedOptions

Options for the sed command.

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

`-n`	`--quiet`	Suppress the default output (in which each line, after it is examined for editing, is written to standard output). Only lines explicitly selected for output are written.
`-g`	`--global`	Globally substitute for all non-overlapping instances of the regexp rather than just the first one. (This option is ignored if the occurrence operand is specified).
`-p`	`--print`	Write the matched line to standard output.
`-l`	`--lineNumber`	Writes the current line number on a separate line to the standard output.
`-I`	`--ignoreCase`	Use case insensitive pattern matching.
`-s`	`--substitute`	Substitutes the replacement string for instances of the regexp in the matched line. The characters "$0" appearing in the replacement are replaced by the line matching the regexp. The characters "$n", where n is a digit other than zero, are replaced by the text matched by the corresponding backreference expression (aka group). The special meaning of "$n" in this context can be suppressed by preceding it by a backslash. A line can be split by substituting a newline ('\n') into it. A substitution is considered to have been performed even if the replacement string is identical to the string that it replaces.
`-a`	`--append`	Append string2 as a separate line after the matched line.
`-i`	`--insert`	Insert string2 as a separate line before the matched line.
`-c`	`--change`	Write string2 as a separate line instead of the matched line.
`-d`	`--delete`	Delete the matched line.
`-y`	`--translate`	Replace all occurrences of characters in string1 with the corresponding characters in string2. If the number of characters in the two strings are not equal, or if any of the characters in string1 appear more than once, the results are undefined.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.unix4j.unix.sed.SedOptions
  SedOptions.Default

Enum Constant Summary

Enum Constants
Enum Constant and Description
`append` Option `--append`, `-a`: Append string2 as a separate line after the matched line.
`change` Option `--change`, `-c`: Write string2 as a separate line instead of the matched line.
`delete` Option `--delete`, `-d`: Delete the matched line.
`global` Option `--global`, `-g`: Globally substitute for all non-overlapping instances of the regexp rather than just the first one.
`ignoreCase` Option `--ignoreCase`, `-I`: Use case insensitive pattern matching.
`insert` Option `--insert`, `-i`: Insert string2 as a separate line before the matched line.
`lineNumber` Option `--lineNumber`, `-l`: Writes the current line number on a separate line to the standard output.
`print` Option `--print`, `-p`: Write the matched line to standard output.
`quiet` Option `--quiet`, `-n`: Suppress the default output (in which each line, after it is examined for editing, is written to standard output).
`substitute` Option `--substitute`, `-s`: Substitutes the replacement string for instances of the regexp in the matched line.
`translate` Option `--translate`, `-y`: Replace all occurrences of characters in string1 with the corresponding characters in string2.

Field Summary
- Fields inherited from interface org.unix4j.unix.sed.SedOptions
  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<SedOption>`	`asSet()` Returns a new set with `this` active option.
`static SedOption`	`findByAcronym(char acronym)` Returns the option with the given `acronym`, or `null` if no such option is found.
`boolean`	`isSet(SedOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<SedOption>`	`iterator()` Returns an immutable iterator returning o single element: `this` option.
`Class<SedOption>`	`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(SedOption option)` Returns true if the `acronym` should be used for the specified `option` in string representations.
`static SedOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SedOption[]`	`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
  - quiet
```
public static final SedOption quiet
```
    Option --quiet, -n: Suppress the default output (in which each line, after it is examined for editing, is written to standard output). Only lines explicitly selected for output are written.
  - global
```
public static final SedOption global
```
    Option --global, -g: Globally substitute for all non-overlapping instances of the regexp rather than just the first one.
    (This option is ignored if the occurrence operand is specified).
  - print
```
public static final SedOption print
```
    Option --print, -p: Write the matched line to standard output.
  - lineNumber
```
public static final SedOption lineNumber
```
    Option --lineNumber, -l: Writes the current line number on a separate line to the standard output.
  - ignoreCase
```
public static final SedOption ignoreCase
```
    Option --ignoreCase, -I: Use case insensitive pattern matching.
  - substitute
```
public static final SedOption substitute
```
    Option --substitute, -s: Substitutes the replacement string for instances of the regexp in the matched line.
    The characters "$0" appearing in the replacement are replaced by the line matching the regexp. The characters "$n", where n is a digit other than zero, are replaced by the text matched by the corresponding backreference expression (aka group). The special meaning of "$n" in this context can be suppressed by preceding it by a backslash.
    A line can be split by substituting a newline ('\n') into it.
    A substitution is considered to have been performed even if the replacement string is identical to the string that it replaces.
  - append
```
public static final SedOption append
```
    Option --append, -a: Append string2 as a separate line after the matched line.
  - insert
```
public static final SedOption insert
```
    Option --insert, -i: Insert string2 as a separate line before the matched line.
  - change
```
public static final SedOption change
```
    Option --change, -c: Write string2 as a separate line instead of the matched line.
  - delete
```
public static final SedOption delete
```
    Option --delete, -d: Delete the matched line.
  - translate
```
public static final SedOption translate
```
    Option --translate, -y: Replace all occurrences of characters in string1 with the corresponding characters in string2. If the number of characters in the two strings are not equal, or if any of the characters in string1 appear more than once, the results are undefined.
- Method Detail
  - values
```
public static SedOption[] 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 (SedOption c : SedOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SedOption 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<SedOption> optionType()
```
    Description copied from interface: OptionSet
    
    Returns the option type class, usually an enum.
    
    Specified by:
    
    optionType in interface OptionSet<SedOption>
    
    Returns:
    
    the option type
  - findByAcronym
```
public static SedOption 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(SedOption option)
```
    Description copied from interface: OptionSet
    
    Returns true if the specified option is set and false otherwise
    
    Specified by:
    
    isSet in interface OptionSet<SedOption>
    
    Parameters:
    
    option - the option to test
    
    Returns:
    
    true if option is set in this OptionSet
  - asSet
```
public EnumSet<SedOption> asSet()
```
    Returns a new set with this active option.
    
    Specified by:
    
    asSet in interface OptionSet<SedOption>
    
    Returns:
    
    a new set containing this option
  - iterator
```
public Iterator<SedOption> iterator()
```
    Returns an immutable iterator returning o single element: this option.
    
    Specified by:
    
    iterator in interface Iterable<SedOption>
    
    Specified by:
    
    iterator in interface OptionSet<SedOption>
    
    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<SedOption>
    
    Returns:
    
    one
  - useAcronymFor
```
public boolean useAcronymFor(SedOption 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<SedOption>
    
    Parameters:
    
    option - the option of interest
    
    Returns:
    
    always true indicating that option acronyms should be used in string representations for all options

Enum SedOption

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.sed.SedOptions

Enum Constant Summary

Field Summary

Fields inherited from interface org.unix4j.unix.sed.SedOptions

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

quiet

global

print

lineNumber

ignoreCase

substitute

append

insert

change

delete

translate

Method Detail

values

valueOf

optionType

findByAcronym

acronym

isSet

asSet

iterator

size

useAcronymFor