SedFactory (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- org.unix4j.unix.sed.SedFactory

All Implemented Interfaces:

CommandInterface<SedCommand>, Sed.Interface<SedCommand>
```
public final class SedFactory
extends Object
implements Sed.Interface<SedCommand>
```
Factory for the sed command returning a new command instance from every signature method.

Field Summary

Fields
Modifier and Type Field and Description

static SedFactory INSTANCE
The singleton instance of this factory.

Fields
Modifier and Type	Field and Description
`static SedFactory`	`INSTANCE` The singleton instance of this factory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SedCommand`	`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.
`SedCommand`	`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.
`SedCommand`	`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.
`SedCommand`	`sed(String... args)` Executes the sed script specified by the given arguments and writes the result to the standard output.
`SedCommand`	`sed(String script)` Executes the given sed script, such as "s/original/replacement/g".
`SedCommand`	`sed(String regexp, String replacement)` Substitutes the replacement string for instances of the regexp in the matched line.
`SedCommand`	`sed(String regexp, String replacement, int... occurrence)` Substitutes the replacement string for instances of the regexp in the matched line.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final SedFactory INSTANCE
```
    The singleton instance of this factory.
- Method Detail
  - sed
```
public SedCommand sed(String... args)
```
    Description copied from interface: Sed.Interface
    
    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.
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    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
```
public SedCommand sed(String script)
```
    Description copied from interface: Sed.Interface
    
    Executes the given sed script, such as "s/original/replacement/g".
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    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
```
public SedCommand sed(String regexp,
                      String replacement)
```
    Description copied from interface: Sed.Interface
    
    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.
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    Parameters:
    
    regexp - Regular expression matched against a line.
    
    replacement - Replacement string for substitute command. 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.
    
    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
```
public SedCommand sed(String regexp,
                      String replacement,
                      int... occurrence)
```
    Description copied from interface: Sed.Interface
    
    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.
    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.
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    Parameters:
    
    regexp - Regular expression matched against a line.
    
    replacement - Replacement string for substitute command. 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.
    
    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
```
public SedCommand sed(SedOptions options,
                      String regexp)
```
    Description copied from interface: Sed.Interface
    
    Executes the sed command specified by the given options or executes the print command p if no command option has been declared.
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    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
```
public SedCommand sed(SedOptions options,
                      String string1,
                      String string2)
```
    Description copied from interface: Sed.Interface
    
    Executes the sed command specified by the given options or executes the substitute command s if no command option has been declared.
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    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: 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.
    (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
```
public SedCommand sed(SedOptions options,
                      String string1,
                      String string2,
                      int... occurrence)
```
    Description copied from interface: Sed.Interface
    
    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.
    
    Specified by:
    
    sed in interface Sed.Interface<SedCommand>
    
    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: 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.
    (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

Class SedFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Method Detail

sed

sed

sed

sed

sed

sed

sed