org.unix4j.unix

Interface Cat.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:

CatFactory, DefaultUnix4jCommandBuilder

Enclosing class:

Cat

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

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

Method Summary

Modifier and Type	Method and Description
R	cat() Reads the lines from the standard input and writes them to the standard output.
R	cat(CatOptions options) Reads the lines from the standard input and writes them to the standard output; the given options define the details of the output format.
R	cat(CatOptions options, File... files) Reads the lines from the specified files and writes them to the standard output; the given options define the details of the output format.
R	cat(CatOptions options, Input... inputs) Reads the lines from the specified inputs and writes them to the standard output; the given options define the details of the output format.
R	cat(CatOptions options, String... paths) Reads the lines from the specified files and writes them to the standard output; the given options define the details of the output format.
R	cat(File... files) Reads the lines from the specified files and writes them to the standard output.
R	cat(Input... inputs) Reads the lines from the specified inputs and writes them to the standard output.
R	cat(String... args) Reads the lines from files specified as arguments and writes them to the standard output.

Method Detail

cat

R cat()

Reads the lines from the standard input and writes them to the standard output.

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

cat

R cat(String... args)

Reads the lines from files specified as arguments and writes them to the standard output. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). File arguments are expanded if wildcards are used. All file arguments are processed in command-argument order.

Parameters:

args - String arguments defining the options and file operands for the command. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). File arguments are expanded if wildcards are used.

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

cat

R cat(File... files)

Reads the lines from the specified files and writes them to the standard output. The files are processed in command-argument order.

Parameters:

files - The input files to be printed; relative paths are not resolved (use the string path 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

cat

R cat(Input... inputs)

Reads the lines from the specified inputs and writes them to the standard output. The inputs are processed in command-argument order.

Parameters:

inputs - The inputs to be printed.

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

cat

R cat(CatOptions options)

Reads the lines from the standard input and writes them to the standard output; the given options define the details of the output format.

Parameters:

options - Options for the cat command.

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

cat

R cat(CatOptions options,
      File... files)

Reads the lines from the specified files and writes them to the standard output; the given options define the details of the output format. The files are processed in command-argument order.

Parameters:

options - Options for the cat command.

files - The input files to be printed; relative paths are not resolved (use the string path 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

cat

R cat(CatOptions options,
      String... paths)

Reads the lines from the specified files and writes them to the standard output; the given options define the details of the output format. The path arguments are expanded if wildcards are used and processed in command-argument order.

Parameters:

options - Options for the cat command.

paths - Path names of the input files to be printed; 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

cat

R cat(CatOptions options,
      Input... inputs)

Reads the lines from the specified inputs and writes them to the standard output; the given options define the details of the output format. The inputs are processed in command-argument order.

Parameters:

options - Options for the cat command.

inputs - The inputs to be printed.

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