GrepArguments (unix4j 0.4 API)

java.lang.Object
- org.unix4j.unix.grep.GrepArguments

All Implemented Interfaces:

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`String[]`	`getArgs()` Returns the `<args>` operand value: String arguments defining the options and operands for the command.
`File[]`	`getFiles()` Returns the `<files>` operand value: The input files to be searched for the pattern; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
`GrepArguments`	`getForContext(ExecutionContext context)` Returns an arguments object for the given execution context with resolved variables if necessary and possible.
`GrepOptions`	`getOptions()` Returns the options set containing the selected command options.
`String[]`	`getPaths()` Returns the `<paths>` operand value: Pathnames of the input files to be searched for the pattern; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
`Pattern`	`getPattern()` Returns the `<pattern>` operand value: Lines will be printed which match the given pattern.
`String`	`getRegexp()` Returns the `<regexp>` operand value (variables are NOT resolved): Lines will be printed which match the given regular expression.
`String`	`getRegexp(ExecutionContext context)` Returns the `<regexp>` (variables are resolved): Lines will be printed which match the given regular expression.
`boolean`	`isArgsSet()` Returns true if the `<args>` operand has been set.
`boolean`	`isCount()` Returns true if the `--count` option is set.
`boolean`	`isFilesSet()` Returns true if the `<files>` operand has been set.
`boolean`	`isFixedStrings()` Returns true if the `--fixedStrings` option is set.
`boolean`	`isIgnoreCase()` Returns true if the `--ignoreCase` option is set.
`boolean`	`isInvertMatch()` Returns true if the `--invertMatch` option is set.
`boolean`	`isLineNumber()` Returns true if the `--lineNumber` option is set.
`boolean`	`isMatchingFiles()` Returns true if the `--matchingFiles` option is set.
`boolean`	`isPathsSet()` Returns true if the `<paths>` operand has been set.
`boolean`	`isPatternSet()` Returns true if the `<pattern>` operand has been set.
`boolean`	`isRegexpSet()` Returns true if the `<regexp>` operand has been set.
`boolean`	`isWholeLine()` Returns true if the `--wholeLine` option is set.
`void`	`setFiles(File... files)` Sets `<files>`: The input files to be searched for the pattern; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
`void`	`setPaths(String... paths)` Sets `<paths>`: Pathnames of the input files to be searched for the pattern; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
`void`	`setPattern(Pattern pattern)` Sets `<pattern>`: Lines will be printed which match the given pattern.
`void`	`setRegexp(String regexp)` Sets `<regexp>`: Lines will be printed which match the given regular expression.
`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
  - GrepArguments
```
public GrepArguments()
```
    Constructor to use if no options are specified.
  - GrepArguments
```
public GrepArguments(GrepOptions options)
```
    Constructor with option set containing the selected command options.
    
    Parameters:
    options - the selected options
    
    Throws:
    
    NullPointerException - if the argument is null
  - GrepArguments
```
public GrepArguments(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 GrepOptions 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 GrepArguments 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<GrepArguments>
    
    Parameters:
    context - the execution context providing access to variables and converters
    
    Returns:
    an arguments object with resolved variables where possible
  - getRegexp
```
public String getRegexp()
```
    Returns the <regexp> operand value (variables are NOT resolved): Lines will be printed which match the given regular expression. The regexp string is surrounded with ".*" on both sides unless the --wholeLine option is specified. If the --fixedStrings option is used, plain string comparison is used instead of regular expression matching.
    
    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): Lines will be printed which match the given regular expression. The regexp string is surrounded with ".*" on both sides unless the --wholeLine option is specified. If the --fixedStrings option is used, plain string comparison is used instead of regular expression matching.
    
    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>: Lines will be printed which match the given regular expression. The regexp string is surrounded with ".*" on both sides unless the --wholeLine option is specified. If the --fixedStrings option is used, plain string comparison is used instead of regular expression matching.
    
    Parameters:
    regexp - the value for the <regexp> operand
  - getPattern
```
public Pattern getPattern()
```
    Returns the <pattern> operand value: Lines will be printed which match the given pattern.
    
    Returns:
    the <pattern> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isPatternSet
```
public boolean isPatternSet()
```
    Returns true if the <pattern> operand has been set.
    Note that this method returns true even if null was passed to the setPattern(java.util.regex.Pattern) method.
    
    Returns:
    true if the setter for the <pattern> operand has been called at least once
  - setPattern
```
public void setPattern(Pattern pattern)
```
    Sets <pattern>: Lines will be printed which match the given pattern.
    
    Parameters:
    pattern - the value for the <pattern> operand
  - getPaths
```
public String[] getPaths()
```
    Returns the <paths> operand value: Pathnames of the input files to be searched for the pattern; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
    
    Returns:
    the <paths> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isPathsSet
```
public boolean isPathsSet()
```
    Returns true if the <paths> operand has been set.
    Note that this method returns true even if null was passed to the setPaths(String[]) method.
    
    Returns:
    true if the setter for the <paths> operand has been called at least once
  - setPaths
```
public void setPaths(String... paths)
```
    Sets <paths>: Pathnames of the input files to be searched for the pattern; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
    
    Parameters:
    paths - the value for the <paths> operand
  - getFiles
```
public File[] getFiles()
```
    Returns the <files> operand value: The input files to be searched for the pattern; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
    
    Returns:
    the <files> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isFilesSet
```
public boolean isFilesSet()
```
    Returns true if the <files> operand has been set.
    Note that this method returns true even if null was passed to the setFiles(java.io.File[]) method.
    
    Returns:
    true if the setter for the <files> operand has been called at least once
  - setFiles
```
public void setFiles(File... files)
```
    Sets <files>: The input files to be searched for the pattern; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
    
    Parameters:
    files - the value for the <files> 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 "--pattern" and "--paths" operands have to be prefixed with the operand name (e.g. "--files" for subsequent file operand values).
    
    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
  - isIgnoreCase
```
public boolean isIgnoreCase()
```
    Returns true if the --ignoreCase option is set. The option is also known as -i option.
    Description: Match lines ignoring the case when comparing the strings, also known from Unix with its acronym 'i'.
    
    Returns:
    true if the --ignoreCase or -i option is set
  - isInvertMatch
```
public boolean isInvertMatch()
```
    Returns true if the --invertMatch option is set. The option is also known as -v option.
    Description: 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'.
    
    Returns:
    true if the --invertMatch or -v option is set
  - isFixedStrings
```
public boolean isFixedStrings()
```
    Returns true if the --fixedStrings option is set. The option is also known as -F option.
    Description: 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).
    
    Returns:
    true if the --fixedStrings or -F option is set
  - isLineNumber
```
public boolean isLineNumber()
```
    Returns true if the --lineNumber option is set. The option is also known as -n option.
    Description: Prefix each line of output with the line number within its input file.
    
    Returns:
    true if the --lineNumber or -n option is set
  - isCount
```
public boolean isCount()
```
    Returns true if the --count option is set. The option is also known as -c option.
    Description: Suppress normal output; instead print a count of matching lines for each input file. With the -v, --invertMatch option, count non-matching lines.
    
    Returns:
    true if the --count or -c option is set
  - isMatchingFiles
```
public boolean isMatchingFiles()
```
    Returns true if the --matchingFiles option is set. The option is also known as -l option.
    Description: 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.
    
    Returns:
    true if the --matchingFiles or -l option is set
  - isWholeLine
```
public boolean isWholeLine()
```
    Returns true if the --wholeLine option is set. The option is also known as -x option.
    Description: 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).
    
    Returns:
    true if the --wholeLine or -x 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<GrepArguments>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"

Class GrepArguments

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrepArguments

GrepArguments

GrepArguments

Method Detail

getOptions

getForContext

getRegexp

getRegexp

isRegexpSet

setRegexp

getPattern

isPatternSet

setPattern

getPaths

isPathsSet

setPaths

getFiles

isFilesSet

setFiles

getArgs

isArgsSet

isIgnoreCase

isInvertMatch

isFixedStrings

isLineNumber

isCount

isMatchingFiles

isWholeLine

toString