org.unix4j.unix.xargs

Class XargsFactory

java.lang.Object

org.unix4j.unix.xargs.XargsFactory

All Implemented Interfaces:

CommandInterface<XargsCommand>, Xargs.Interface<XargsCommand>

public final class XargsFactory
extends Object
implements Xargs.Interface<XargsCommand>

Factory for the xargs command returning a new command instance from every signature method.

Field Summary

Fields

Modifier and Type	Field and Description
static XargsFactory	INSTANCE The singleton instance of this factory.

Method Summary

Methods

Modifier and Type	Method and Description
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.
XargsCommand	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final XargsFactory INSTANCE

The singleton instance of this factory.

Method Detail

xargs

public XargsCommand xargs()

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(String... args)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(String delimiter)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(long maxLines)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(long maxLines,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(String delimiter,
                 long maxLines)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(String delimiter,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(String delimiter,
                 long maxLines,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(String delimiter,
                 String eof,
                 long maxLines,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options,
                 String delimiter)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options,
                 long maxLines)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options,
                 long maxLines,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options,
                 String delimiter,
                 long maxLines)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

public XargsCommand xargs(XargsOptions options,
                 String delimiter,
                 int maxArgs)

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

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

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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

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

Description copied from interface: Xargs.Interface

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.

Specified by:

xargs in interface Xargs.Interface<XargsCommand>

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