Sed.Interface (unix4j 0.4 API)

Type Parameters:
R - the generic return type for all command signature methods to support different implementor types; the methods of a command factory for instance returns a command instance; command builders can also implement this interface, but their methods return the builder itself enabling for chained method invocation to create joined commands

All Superinterfaces:

CommandInterface<R>

All Known Subinterfaces:

Unix4jCommandBuilder

All Known Implementing Classes:

DefaultUnix4jCommandBuilder, SedFactory

Enclosing class:

Sed
```
public static interface Sed.Interface<R>
extends CommandInterface<R>
```
Interface defining all method signatures for the "sed" command.

Method Summary

Methods
Modifier and Type	Method and Description
`R`	`sed(SedOptions options, String regexp)` Executes the sed command specified by the given options or executes the print command p if no command option has been declared.
`R`	`sed(SedOptions options, String string1, String string2)` Executes the sed command specified by the given options or executes the substitute command s if no command option has been declared.
`R`	`sed(SedOptions options, String string1, String string2, int... occurrence)` Executes the sed command specified by the given options or executes the substitute command s if no command option has been declared.
`R`	`sed(String... args)` Executes the sed script specified by the given arguments and writes the result to the standard output.
`R`	`sed(String script)` Executes the given sed script, such as "s/original/replacement/g".
`R`	`sed(String regexp, String replacement)` Substitutes the replacement string for instances of the regexp in the matched line.
`R`	`sed(String regexp, String replacement, int... occurrence)` Substitutes the replacement string for instances of the regexp in the matched line.

- Method Detail
  - sed
```
R sed(String... args)
```
    Executes the sed script specified by the given arguments and writes the result to the standard output.
    Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). Operands other than the default "--script" operand have to be prefixed with the operand name.
    
    Parameters:
    args - String arguments defining the options and operands for the command. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). Operands other than the default "--script" operand have to be prefixed with the operand name (e.g. "--occurrence" for subsequent occurrence indices).
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details
  - sed
```
R sed(String script)
```
    Executes the given sed script, such as "s/original/replacement/g".
    
    Parameters:
    script - Sed script as one string, such as "s/original/replacement/g".
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details
  - sed
```
R sed(String regexp,
    String replacement)
```
    Substitutes the replacement string for instances of the regexp in the matched line.
    An ampersand ('&') appearing in the replacement is be replaced by the line matching the regexp. The characters "\n", where n is a digit, are replaced by the text matched by the corresponding backreference expression. The special meaning of '&' and "\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.
    
    Parameters:
    regexp - Regular expression matched against a line.
    replacement - Replacement string for substitute command. An ampersand ('&') appearing in the replacement string is replaced by the string matching the regular expression. The characters "\n", where n is a digit, are replaced by the text matched by the corresponding backreference expression. The special meaning of '&' and "\n" in this context can be suppressed by preceding it by a backslash.
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details
  - sed
```
R sed(String regexp,
    String replacement,
    int... occurrence)
```
    Substitutes the replacement string for instances of the regexp in the matched line. Only the given occurrences of the regexp found within the matched string are substituted.
    An ampersand ('&') appearing in the replacement is be replaced by the line matching the regexp. The characters "\n", where n is a digit, are replaced by the text matched by the corresponding backreference expression. The special meaning of '&' and "\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.
    
    Parameters:
    regexp - Regular expression matched against a line.
    replacement - Replacement string for substitute command. An ampersand ('&') appearing in the replacement string is replaced by the string matching the regular expression. The characters "\n", where n is a digit, are replaced by the text matched by the corresponding backreference expression. The special meaning of '&' and "\n" in this context can be suppressed by preceding it by a backslash.
    occurrence - Substitute for the given occurrences only of the regexp found within the matched string; the occurrence indices are one-based. If empty or omitted, all occurrences are substituted.
    (This operand only applies to the substitute command and is ignored by all other commands).
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details
  - sed
```
R sed(SedOptions options,
    String regexp)
```
    Executes the sed command specified by the given options or executes the print command p if no command option has been declared.
    
    Parameters:
    options - Sed options and commands
    regexp - Regular expression matched against a line.
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details
  - sed
```
R sed(SedOptions options,
    String string1,
    String string2)
```
    Executes the sed command specified by the given options or executes the substitute command s if no command option has been declared.
    
    Parameters:
    options - Sed options and commands
    string1 - Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
    string2 - Replacement string for substitute command s; appended, inserted or changed text for a, i and c command; destination characters for translate command y; ignored by all other commands.
    If string2 is a replacement string for the substitute command: an ampersand ('&') appearing in the replacement string is replaced by the string matching the regular expression; the characters "\n", where n is a digit, are replaced by the text matched by the corresponding backreference expression. The special meaning of '&' and "\n" in this context can be suppressed by preceding it by a backslash.
    (This operand only applies to the commands s, a, i, c and y and is ignored by all other commands).
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details
  - sed
```
R sed(SedOptions options,
    String string1,
    String string2,
    int... occurrence)
```
    Executes the sed command specified by the given options or executes the substitute command s if no command option has been declared.
    The string1 operand usually contains the regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
    The string2 operand contains the replacement string for the substitute command s. It contains the appended, inserted or changed text for the commands a, i and c, respectively, and the destination characters for the translate command y. All other commands ignore the string2 operand.
    
    Parameters:
    options - Sed options and commands
    string1 - Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
    string2 - Replacement string for substitute command s; appended, inserted or changed text for a, i and c command; destination characters for translate command y; ignored by all other commands.
    If string2 is a replacement string for the substitute command: an ampersand ('&') appearing in the replacement string is replaced by the string matching the regular expression; the characters "\n", where n is a digit, are replaced by the text matched by the corresponding backreference expression. The special meaning of '&' and "\n" in this context can be suppressed by preceding it by a backslash.
    (This operand only applies to the commands s, a, i, c and y and is ignored by all other commands).
    occurrence - Substitute for the given occurrences only of the regexp found within the matched string; the occurrence indices are one-based. If empty or omitted, all occurrences are substituted.
    (This operand only applies to the substitute command and is ignored by all other commands).
    
    Returns:
    the generic type <R> defined by the implementing class; the command itself returns no value and writes its result to the standard output; see class level parameter comments for more details

Interface Sed.Interface<R>

Method Summary

Method Detail

sed

sed

sed

sed

sed

sed

sed