SedArguments (unix4j 0.7-SNAPSHOT API)

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

All Implemented Interfaces:

Arguments<SedArguments>
```
public final class SedArguments
extends Object
implements Arguments<SedArguments>
```
Arguments and options for the sed command.

Constructor Summary

Constructors
Constructor and Description
`SedArguments()` Constructor to use if no options are specified.
`SedArguments(SedOptions options)` Constructor with option set containing the selected command options.
`SedArguments(String... args)` Constructor string arguments encoding options and arguments, possibly also containing variable expressions.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getArgs()` Returns the `<args>` operand value: String arguments defining the options and operands for the command.
`SedArguments`	`getForContext(ExecutionContext context)` Returns an arguments object for the given execution context with resolved variables if necessary and possible.
`int[]`	`getOccurrence()` Returns the `<occurrence>` operand value: Substitute for the given occurrences only of the regexp found within the matched string; the occurrence indices are one-based.
`SedOptions`	`getOptions()` Returns the options set containing the selected command options.
`String`	`getRegexp()` Returns the `<regexp>` operand value (variables are NOT resolved): Regular expression matched against a line.
`String`	`getRegexp(ExecutionContext context)` Returns the `<regexp>` (variables are resolved): Regular expression matched against a line.
`String`	`getReplacement()` Returns the `<replacement>` operand value (variables are NOT resolved): Replacement string for substitute command.
`String`	`getReplacement(ExecutionContext context)` Returns the `<replacement>` (variables are resolved): Replacement string for substitute command.
`String`	`getScript()` Returns the `<script>` operand value (variables are NOT resolved): Sed script as one string, such as "s/original/replacement/g".
`String`	`getScript(ExecutionContext context)` Returns the `<script>` (variables are resolved): Sed script as one string, such as "s/original/replacement/g".
`String`	`getString1()` Returns the `<string1>` operand value (variables are NOT resolved): Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
`String`	`getString1(ExecutionContext context)` Returns the `<string1>` (variables are resolved): Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
`String`	`getString2()` Returns the `<string2>` operand value (variables are NOT resolved): 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.
`String`	`getString2(ExecutionContext context)` Returns the `<string2>` (variables are resolved): 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.
`boolean`	`isAppend()` Returns true if the `--append` option is set.
`boolean`	`isArgsSet()` Returns true if the `<args>` operand has been set.
`boolean`	`isChange()` Returns true if the `--change` option is set.
`boolean`	`isDelete()` Returns true if the `--delete` option is set.
`boolean`	`isGlobal()` Returns true if the `--global` option is set.
`boolean`	`isIgnoreCase()` Returns true if the `--ignoreCase` option is set.
`boolean`	`isInsert()` Returns true if the `--insert` option is set.
`boolean`	`isLineNumber()` Returns true if the `--lineNumber` option is set.
`boolean`	`isOccurrenceSet()` Returns true if the `<occurrence>` operand has been set.
`boolean`	`isPrint()` Returns true if the `--print` option is set.
`boolean`	`isQuiet()` Returns true if the `--quiet` option is set.
`boolean`	`isRegexpSet()` Returns true if the `<regexp>` operand has been set.
`boolean`	`isReplacementSet()` Returns true if the `<replacement>` operand has been set.
`boolean`	`isScriptSet()` Returns true if the `<script>` operand has been set.
`boolean`	`isString1Set()` Returns true if the `<string1>` operand has been set.
`boolean`	`isString2Set()` Returns true if the `<string2>` operand has been set.
`boolean`	`isSubstitute()` Returns true if the `--substitute` option is set.
`boolean`	`isTranslate()` Returns true if the `--translate` option is set.
`void`	`setOccurrence(int... occurrence)` Sets `<occurrence>`: Substitute for the given occurrences only of the regexp found within the matched string; the occurrence indices are one-based.
`void`	`setRegexp(String regexp)` Sets `<regexp>`: Regular expression matched against a line.
`void`	`setReplacement(String replacement)` Sets `<replacement>`: Replacement string for substitute command.
`void`	`setScript(String script)` Sets `<script>`: Sed script as one string, such as "s/original/replacement/g".
`void`	`setString1(String string1)` Sets `<string1>`: Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
`void`	`setString2(String string2)` Sets `<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.
`String`	`toString()` Returns a string representation of the command arguments and options.

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

- Constructor Detail
  - SedArguments
```
public SedArguments()
```
    Constructor to use if no options are specified.
  - SedArguments
```
public SedArguments(SedOptions options)
```
    Constructor with option set containing the selected command options.
    
    Parameters:
    
    options - the selected options
    
    Throws:
    
    NullPointerException - if the argument is null
  - SedArguments
```
public SedArguments(String... args)
```
    Constructor string arguments encoding options and arguments, possibly also containing variable expressions.
    
    Parameters:
    
    args - string arguments for the command
    
    Throws:
    
    NullPointerException - if args is null
- Method Detail
  - getOptions
```
public SedOptions getOptions()
```
    Returns the options set containing the selected command options. Returns an empty options set if no option has been selected.
    
    Returns:
    
    set with the selected options
  - getForContext
```
public SedArguments getForContext(ExecutionContext context)
```
    Description copied from interface: Arguments
    
    Returns an arguments object for the given execution context with resolved variables if necessary and possible. If variables are defined in this arguments instance, a new arguments instance is created with values instead of variables for those variables that are defined in the specified context object. If this arguments instance uses no variables, this arguments instance is simply returned.
    If variables are present, they are resolved if such a variable is defined in the VariableContext returned by context.getVariableContext(). Values are converted if necessary with the ValueConverters returned by context.getValueConverterFor(Class).
    
    Specified by:
    
    getForContext in interface Arguments<SedArguments>
    
    Parameters:
    
    context - the execution context providing access to variables and converters
    
    Returns:
    
    an arguments object with resolved variables where possible
  - getScript
```
public String getScript()
```
    Returns the <script> operand value (variables are NOT resolved): Sed script as one string, such as "s/original/replacement/g".
    
    Returns:
    
    the <script> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getScript(ExecutionContext)
  - getScript
```
public String getScript(ExecutionContext context)
```
    Returns the <script> (variables are resolved): Sed script as one string, such as "s/original/replacement/g".
    
    Parameters:
    
    context - the execution context used to resolve variables
    
    Returns:
    
    the <script> operand value after resolving variables
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getScript()
  - isScriptSet
```
public boolean isScriptSet()
```
    Returns true if the <script> operand has been set.
    Note that this method returns true even if null was passed to the setScript(String) method.
    
    Returns:
    
    true if the setter for the <script> operand has been called at least once
  - setScript
```
public void setScript(String script)
```
    Sets <script>: Sed script as one string, such as "s/original/replacement/g".
    
    Parameters:
    
    script - the value for the <script> operand
  - getRegexp
```
public String getRegexp()
```
    Returns the <regexp> operand value (variables are NOT resolved): Regular expression matched against a line.
    
    Returns:
    
    the <regexp> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getRegexp(ExecutionContext)
  - getRegexp
```
public String getRegexp(ExecutionContext context)
```
    Returns the <regexp> (variables are resolved): Regular expression matched against a line.
    
    Parameters:
    
    context - the execution context used to resolve variables
    
    Returns:
    
    the <regexp> operand value after resolving variables
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getRegexp()
  - isRegexpSet
```
public boolean isRegexpSet()
```
    Returns true if the <regexp> operand has been set.
    Note that this method returns true even if null was passed to the setRegexp(String) method.
    
    Returns:
    
    true if the setter for the <regexp> operand has been called at least once
  - setRegexp
```
public void setRegexp(String regexp)
```
    Sets <regexp>: Regular expression matched against a line.
    
    Parameters:
    
    regexp - the value for the <regexp> operand
  - getString1
```
public String getString1()
```
    Returns the <string1> operand value (variables are NOT resolved): Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
    
    Returns:
    
    the <string1> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getString1(ExecutionContext)
  - getString1
```
public String getString1(ExecutionContext context)
```
    Returns the <string1> (variables are resolved): Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
    
    Parameters:
    
    context - the execution context used to resolve variables
    
    Returns:
    
    the <string1> operand value after resolving variables
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getString1()
  - isString1Set
```
public boolean isString1Set()
```
    Returns true if the <string1> operand has been set.
    Note that this method returns true even if null was passed to the setString1(String) method.
    
    Returns:
    
    true if the setter for the <string1> operand has been called at least once
  - setString1
```
public void setString1(String string1)
```
    Sets <string1>: Regular expression matched against a line for all commands except for command y where string1 contains the source characters for the translation.
    
    Parameters:
    
    string1 - the value for the <string1> operand
  - getReplacement
```
public String getReplacement()
```
    Returns the <replacement> operand value (variables are NOT resolved): 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 <replacement> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getReplacement(ExecutionContext)
  - getReplacement
```
public String getReplacement(ExecutionContext context)
```
    Returns the <replacement> (variables are resolved): 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.
    
    Parameters:
    
    context - the execution context used to resolve variables
    
    Returns:
    
    the <replacement> operand value after resolving variables
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getReplacement()
  - isReplacementSet
```
public boolean isReplacementSet()
```
    Returns true if the <replacement> operand has been set.
    Note that this method returns true even if null was passed to the setReplacement(String) method.
    
    Returns:
    
    true if the setter for the <replacement> operand has been called at least once
  - setReplacement
```
public void setReplacement(String replacement)
```
    Sets <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.
    
    Parameters:
    
    replacement - the value for the <replacement> operand
  - getString2
```
public String getString2()
```
    Returns the <string2> operand value (variables are NOT resolved): 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 <string2> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getString2(ExecutionContext)
  - getString2
```
public String getString2(ExecutionContext context)
```
    Returns the <string2> (variables are resolved): 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).
    
    Parameters:
    
    context - the execution context used to resolve variables
    
    Returns:
    
    the <string2> operand value after resolving variables
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getString2()
  - isString2Set
```
public boolean isString2Set()
```
    Returns true if the <string2> operand has been set.
    Note that this method returns true even if null was passed to the setString2(String) method.
    
    Returns:
    
    true if the setter for the <string2> operand has been called at least once
  - setString2
```
public void setString2(String string2)
```
    Sets <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).
    
    Parameters:
    
    string2 - the value for the <string2> operand
  - getOccurrence
```
public int[] getOccurrence()
```
    Returns the <occurrence> operand value: 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 <occurrence> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isOccurrenceSet
```
public boolean isOccurrenceSet()
```
    Returns true if the <occurrence> operand has been set.
    Note that this method returns true even if null was passed to the setOccurrence(int[]) method.
    
    Returns:
    
    true if the setter for the <occurrence> operand has been called at least once
  - setOccurrence
```
public void setOccurrence(int... occurrence)
```
    Sets <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).
    
    Parameters:
    
    occurrence - the value for the <occurrence> operand
  - getArgs
```
public String[] getArgs()
```
    Returns the <args> operand value: 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 <args> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isArgsSet
```
public boolean isArgsSet()
```
    Returns true if the <args> operand has been set.
    
    Returns:
    
    true if the setter for the <args> operand has been called at least once
  - isQuiet
```
public boolean isQuiet()
```
    Returns true if the --quiet option is set. The option is also known as -n option.
    Description: 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.
    
    Returns:
    
    true if the --quiet or -n option is set
  - isGlobal
```
public boolean isGlobal()
```
    Returns true if the --global option is set. The option is also known as -g option.
    Description: 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).
    
    Returns:
    
    true if the --global or -g option is set
  - isPrint
```
public boolean isPrint()
```
    Returns true if the --print option is set. The option is also known as -p option.
    Description: Write the matched line to standard output.
    
    Returns:
    
    true if the --print or -p option is set
  - isLineNumber
```
public boolean isLineNumber()
```
    Returns true if the --lineNumber option is set. The option is also known as -l option.
    Description: Writes the current line number on a separate line to the standard output.
    
    Returns:
    
    true if the --lineNumber or -l option is set
  - isIgnoreCase
```
public boolean isIgnoreCase()
```
    Returns true if the --ignoreCase option is set. The option is also known as -I option.
    Description: Use case insensitive pattern matching.
    
    Returns:
    
    true if the --ignoreCase or -I option is set
  - isSubstitute
```
public boolean isSubstitute()
```
    Returns true if the --substitute option is set. The option is also known as -s option.
    Description: 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.
    
    Returns:
    
    true if the --substitute or -s option is set
  - isAppend
```
public boolean isAppend()
```
    Returns true if the --append option is set. The option is also known as -a option.
    Description: Append string2 as a separate line after the matched line.
    
    Returns:
    
    true if the --append or -a option is set
  - isInsert
```
public boolean isInsert()
```
    Returns true if the --insert option is set. The option is also known as -i option.
    Description: Insert string2 as a separate line before the matched line.
    
    Returns:
    
    true if the --insert or -i option is set
  - isChange
```
public boolean isChange()
```
    Returns true if the --change option is set. The option is also known as -c option.
    Description: Write string2 as a separate line instead of the matched line.
    
    Returns:
    
    true if the --change or -c option is set
  - isDelete
```
public boolean isDelete()
```
    Returns true if the --delete option is set. The option is also known as -d option.
    Description: Delete the matched line.
    
    Returns:
    
    true if the --delete or -d option is set
  - isTranslate
```
public boolean isTranslate()
```
    Returns true if the --translate option is set. The option is also known as -y option.
    Description: 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.
    
    Returns:
    
    true if the --translate or -y option is set
  - toString
```
public String toString()
```
    Description copied from interface: Arguments
    
    Returns a string representation of the command arguments and options.
    
    Specified by:
    
    toString in interface Arguments<SedArguments>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"

Class SedArguments

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SedArguments

SedArguments

SedArguments

Method Detail

getOptions

getForContext

getScript

getScript

isScriptSet

setScript

getRegexp

getRegexp

isRegexpSet

setRegexp

getString1

getString1

isString1Set

setString1

getReplacement

getReplacement

isReplacementSet

setReplacement

getString2

getString2

isString2Set

setString2

getOccurrence

isOccurrenceSet

setOccurrence

getArgs

isArgsSet

isQuiet

isGlobal

isPrint

isLineNumber

isIgnoreCase

isSubstitute

isAppend

isInsert

isChange

isDelete

isTranslate

toString