org.unix4j.unix

Interface Xargs.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, XargsFactory

Enclosing class:

Xargs

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

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

Method Summary

Modifier and Type	Method and Description
R	xargs() Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(int maxArgs) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(long maxLines) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(long maxLines, int maxArgs) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(String... args) Reads items from the standard input, delimited by blanks and newlines or a specified delimiter, and provides variables for the items read from the standard input.
R	xargs(String delimiter) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(String delimiter, int maxArgs) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(String delimiter, long maxLines) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(String delimiter, long maxLines, int maxArgs) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(String delimiter, String eof, long maxLines, int maxArgs) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, int maxArgs) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, long maxLines) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, long maxLines, int maxArgs) Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, String delimiter) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, String delimiter, int maxArgs) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, String delimiter, long maxLines) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, String delimiter, long maxLines, int maxArgs) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.
R	xargs(XargsOptions options, String delimiter, String eof, long maxLines, int maxArgs) Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input.

Method Detail

xargs

R xargs()

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every input line; the item variables are usually passed to the invoked command as arguments.

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

xargs

R xargs(String... args)

Reads items from the standard input, delimited by blanks and newlines or a specified delimiter, and provides variables for the items read from the standard input. The command following after xargs is executed once for every input line (or for multiple lines depending on the input options); the item variables are usually passed to the invoked command as arguments.

Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). Operands other than the default "--maxArgs" 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 "--maxArgs" operand have to be prefixed with the operand name (e.g. "--maxLines" for a subsequent line count operand value).

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

xargs

R xargs(String delimiter)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every input line; the item variables are usually passed to the invoked command as arguments.

Parameters:

delimiter - Input items are terminated by the specified characters.

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

xargs

R xargs(long maxLines)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines (or possibly fewer for the last invocation with the remaining lines at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

maxLines - Use at most maxLines nonblank input lines per command invocation.

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

xargs

R xargs(int maxArgs)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxArgs items read from the standard input (or possibly fewer for the last invocation with the remaining items at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(long maxLines,
        int maxArgs)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines or maxArgs items (whichever occurs first). Fewer lines or items may be used for the last invocation with the remaining lines at the end of the file. The item variables are usually passed to the invoked command as arguments.

Parameters:

maxLines - Use at most maxLines nonblank input lines per command invocation.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(String delimiter,
        long maxLines)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines (or possibly fewer for the last invocation with the remaining lines at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

delimiter - Input items are terminated by the specified characters.

maxLines - Use at most maxLines nonblank input lines per command invocation.

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

xargs

R xargs(String delimiter,
        int maxArgs)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxArgs items read from the standard input (or possibly fewer for the last invocation with the remaining items at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

delimiter - Input items are terminated by the specified characters.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(String delimiter,
        long maxLines,
        int maxArgs)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines or maxArgs items (whichever occurs first). Fewer lines or items may be used for the last invocation with the remaining lines at the end of the file. The item variables are usually passed to the invoked command as arguments.

Parameters:

delimiter - Input items are terminated by the specified characters.

maxLines - Use at most maxLines nonblank input lines per command invocation.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(String delimiter,
        String eof,
        long maxLines,
        int maxArgs)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. If the eof string occurs as a line of input, the rest of the input is ignored. The command following after xargs is executed once for every maxLines nonblank input lines or maxArgs items (whichever occurs first). Fewer lines or items may be used for the last invocation with the remaining lines at the end of the file. The item variables are usually passed to the invoked command as arguments.

Parameters:

delimiter - Input items are terminated by the specified characters.

eof - If the end of file string occurs as a line of input, the rest of the input is ignored.

maxLines - Use at most maxLines nonblank input lines per command invocation.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(XargsOptions options)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every input line; the item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

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

xargs

R xargs(XargsOptions options,
        String delimiter)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every input line; the item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

delimiter - Input items are terminated by the specified characters.

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

xargs

R xargs(XargsOptions options,
        long maxLines)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines (or possibly fewer for the last invocation with the remaining lines at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

maxLines - Use at most maxLines nonblank input lines per command invocation.

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

xargs

R xargs(XargsOptions options,
        int maxArgs)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxArgs items read from the standard input (or possibly fewer for the last invocation with the remaining items at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(XargsOptions options,
        long maxLines,
        int maxArgs)

Reads items from the standard input, delimited by blanks (which can be protected with double or single quotes or a backslash) or newlines, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines or maxArgs items (whichever occurs first). Fewer lines or items may be used for the last invocation with the remaining lines at the end of the file. The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

maxLines - Use at most maxLines nonblank input lines per command invocation.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(XargsOptions options,
        String delimiter,
        long maxLines)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines (or possibly fewer for the last invocation with the remaining lines at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

delimiter - Input items are terminated by the specified characters.

maxLines - Use at most maxLines nonblank input lines per command invocation.

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

xargs

R xargs(XargsOptions options,
        String delimiter,
        int maxArgs)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxArgs items read from the standard input (or possibly fewer for the last invocation with the remaining items at the end of the file). The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

delimiter - Input items are terminated by the specified characters.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(XargsOptions options,
        String delimiter,
        long maxLines,
        int maxArgs)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. The command following after xargs is executed once for every maxLines nonblank input lines or maxArgs items (whichever occurs first). Fewer lines or items may be used for the last invocation with the remaining lines at the end of the file. The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

delimiter - Input items are terminated by the specified characters.

maxLines - Use at most maxLines nonblank input lines per command invocation.

maxArgs - Use at most maxArgs arguments per command invocation.

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

xargs

R xargs(XargsOptions options,
        String delimiter,
        String eof,
        long maxLines,
        int maxArgs)

Reads items from the standard input using the specified delimiter to separate items, and provides variables for the items read from the standard input. If the eof string occurs as a line of input, the rest of the input is ignored. The command following after xargs is executed once for every maxLines nonblank input lines or maxArgs items (whichever occurs first). Fewer lines or items may be used for the last invocation with the remaining lines at the end of the file. The item variables are usually passed to the invoked command as arguments.

Parameters:

options - The options defining command behavior.

delimiter - Input items are terminated by the specified characters.

eof - If the end of file string occurs as a line of input, the rest of the input is ignored.

maxLines - Use at most maxLines nonblank input lines per command invocation.

maxArgs - Use at most maxArgs arguments per command invocation.

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