org.unix4j.unix

Interface Grep.Interface<R>

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, GrepFactory

Enclosing class:

Grep

public static interface Grep.Interface<R>
extends CommandInterface<R>

Interface defining all method signatures for the "grep" command.

Method Summary

Modifier and Type	Method and Description
R	grep(GrepOptions options, Pattern pattern) Filters the input lines from the standard input and writes the matching lines to the standard output.
R	grep(GrepOptions options, Pattern pattern, File... files) Filters the input lines from the specified input files and writes the matching lines to the standard output.
R	grep(GrepOptions options, Pattern pattern, Input... inputs) Filters the input lines from the specified inputs and writes the matching lines to the standard output.
R	grep(GrepOptions options, Pattern pattern, String... paths) Filters the input lines from the specified input files and writes the matching lines to the standard output.
R	grep(GrepOptions options, String regexp) Filters the input lines from the standard input and writes the matching lines to the standard output.
R	grep(GrepOptions options, String regexp, File... files) Filters the input lines from the specified input files and writes the matching lines to the standard output.
R	grep(GrepOptions options, String regexp, Input... inputs) Filters the input lines from the specified inputs and writes the matching lines to the standard output.
R	grep(GrepOptions options, String regexp, String... paths) Filters the input lines from the specified input files and writes the matching lines to the standard output.
R	grep(Pattern pattern) Filters the input lines from the standard input and writes the matching lines to the standard output.
R	grep(Pattern pattern, File... files) Filters the lines from the specified input files and writes the matching lines to the standard output.
R	grep(Pattern pattern, Input... inputs) Filters the lines from the specified inputs and writes the matching lines to the standard output.
R	grep(Pattern pattern, String... paths) Filters the lines from the specified input files and writes the matching lines to the standard output.
R	grep(String... args) Filters the input lines from the standard input or the provided input files and writes the matching lines to the standard output.
R	grep(String regexp) Filters the input lines from the standard input and writes the matching lines to the standard output.
R	grep(String regexp, File... files) Filters the lines from the specified input files and writes the matching lines to the standard output.
R	grep(String regexp, Input... inputs) Filters the lines from the specified inputs and writes the matching lines to the standard output.

Method Detail

grep

R grep(String... args)

Filters the input lines from the standard input or the provided input files and writes the matching lines to the standard output. A line matches if it contains the given "--regexp" operand value (default operand).

Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). Operands other than the default "--regexp" and "--paths" operands 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 "--pattern" and "--paths" operands have to be prefixed with the operand name (e.g. "--files" for subsequent file operand values).

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

grep

R grep(String regexp)

Filters the input lines from the standard input and writes the matching lines to the standard output. A line matches if it contains the given regexp using case-sensitive string comparison.

Parameters:

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.

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

grep

R grep(String regexp,
       File... files)

Filters the lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regexp string using case-sensitive comparison. Line endings are not relevant for the comparison.

Parameters:

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.

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).

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

grep

R grep(String regexp,
       Input... inputs)

Filters the lines from the specified inputs and writes the matching lines to the standard output. Every line is matched against the given regexp string using case-sensitive comparison. Line endings are not relevant for the comparison.

Parameters:

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.

inputs - The inputs to be searched for the pattern.

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

grep

R grep(Pattern pattern)

Filters the input lines from the standard input and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern using case-sensitive comparison. Line endings are not relevant for the comparison.

Parameters:

pattern - Lines will be printed which match the given pattern.

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

grep

R grep(Pattern pattern,
       File... files)

Filters the lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern using case-sensitive comparison. Line endings are not relevant for the comparison.

Parameters:

pattern - Lines will be printed which match the given pattern.

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).

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

grep

R grep(Pattern pattern,
       String... paths)

Filters the lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern using case-sensitive comparison. Line endings are not relevant for the comparison.

Parameters:

pattern - Lines will be printed which match the given pattern.

paths - Path names 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 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

grep

R grep(Pattern pattern,
       Input... inputs)

Filters the lines from the specified inputs and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern using case-sensitive comparison. Line endings are not relevant for the comparison.

Parameters:

pattern - Lines will be printed which match the given pattern.

inputs - The inputs to be searched for the pattern.

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

grep

R grep(GrepOptions options,
       String regexp)

Filters the input lines from the standard input and writes the matching lines to the standard output. Every line is matched against the given regexp string; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

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.

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

grep

R grep(GrepOptions options,
       Pattern pattern)

Filters the input lines from the standard input and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

pattern - Lines will be printed which match the given pattern.

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

grep

R grep(GrepOptions options,
       String regexp,
       File... files)

Filters the input lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regexp string; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

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.

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).

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

grep

R grep(GrepOptions options,
       String regexp,
       String... paths)

Filters the input lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regexp string; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

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.

paths - Path names 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 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

grep

R grep(GrepOptions options,
       String regexp,
       Input... inputs)

Filters the input lines from the specified inputs and writes the matching lines to the standard output. Every line is matched against the given regexp string; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

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.

inputs - The inputs to be searched for the pattern.

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

grep

R grep(GrepOptions options,
       Pattern pattern,
       File... files)

Filters the input lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

pattern - Lines will be printed which match the given pattern.

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).

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

grep

R grep(GrepOptions options,
       Pattern pattern,
       String... paths)

Filters the input lines from the specified input files and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

pattern - Lines will be printed which match the given pattern.

paths - Path names 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 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

grep

R grep(GrepOptions options,
       Pattern pattern,
       Input... inputs)

Filters the input lines from the specified inputs and writes the matching lines to the standard output. Every line is matched against the given regular expression pattern; the exact comparison rules are defined by the specified matching options.

Parameters:

options - The options defining the types of patterns and command behavior.

pattern - Lines will be printed which match the given pattern.

inputs - The inputs to be searched for the pattern.

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