org.unix4j.unix

Interface Head.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, HeadFactory

Enclosing class:

Head

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

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

Method Summary

Modifier and Type	Method and Description
R	head() Reads the first 10 lines from the standard input and writes them to the standard output.
R	head(File... files) Reads the first 10 lines from each of the specified files and writes them to the standard output.
R	head(HeadOptions options, long count) Reads the first count lines or characters from the standard input and writes them to the standard output.
R	head(HeadOptions options, long count, File... files) Reads the first count lines or characters from each of the specified files and writes them to the standard output.
R	head(HeadOptions options, long count, Input... inputs) Reads the first count lines or characters from each of the specified inputs and writes them to the standard output.
R	head(HeadOptions options, long count, String... paths) Reads the first count lines or characters from each of the specified files and writes them to the standard output.
R	head(Input... inputs) Reads the first 10 lines from each of the specified inputs and writes them to the standard output.
R	head(long count) Reads the first count lines from the standard input and writes them to the standard output.
R	head(long count, File... files) Reads the first count lines from each of the specified files and writes them to the standard output.
R	head(long count, Input... inputs) Reads the first count lines from each of the specified inputs and writes them to the standard output.
R	head(long count, String... paths) Reads the first count lines from each of the specified files and writes them to the standard output.
R	head(String... args) Reads the first n lines from each of the files specified and writes them to the standard output.

Method Detail

head

R head()

Reads the first 10 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

head

R head(String... args)

Reads the first n lines from each of the files specified and writes them to the standard output. If more than a single file is specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the name of the file.

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

head

R head(long count)

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

Parameters:

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the 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

head

R head(HeadOptions options,
       long count)

Reads the first count lines or characters from the standard input and writes them to the standard output.

Parameters:

options - Options for the head command.

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the 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

head

R head(File... files)

Reads the first 10 lines from each of the specified files and writes them to the standard output. If more than a single file is specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the name of the file.

Parameters:

files - The input files to be filtered; 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

head

R head(Input... inputs)

Reads the first 10 lines from each of the specified inputs and writes them to the standard output. If more than a input is specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the input's string representation.

Parameters:

inputs - The inputs to be filtered.

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

head

R head(long count,
       File... files)

Reads the first count lines from each of the specified files and writes them to the standard output. If more than a single file is specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the name of the file.

Parameters:

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the output.

files - The input files to be filtered; 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

head

R head(long count,
       String... paths)

Reads the first count lines from each of the specified files and writes them to the standard output. If more than a single file is specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the name of the file.

Parameters:

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the output.

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

head

R head(long count,
       Input... inputs)

Reads the first count lines from each of the specified inputs and writes them to the standard output. If more than a single input is specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the input's string representation.

Parameters:

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the output.

inputs - The inputs to be filtered.

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

head

R head(HeadOptions options,
       long count,
       File... files)

Reads the first count lines or characters from each of the specified files and writes them to the standard output. If more than a single file is specified and the -q option is not specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the name of the file.

Parameters:

options - Options for the head command.

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the output.

files - The input files to be filtered; 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

head

R head(HeadOptions options,
       long count,
       String... paths)

Reads the first count lines or characters from each of the specified files and writes them to the standard output. If more than a single file is specified and the -q option is not specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the name of the file.

Parameters:

options - Options for the head command.

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the output.

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

head

R head(HeadOptions options,
       long count,
       Input... inputs)

Reads the first count lines or characters from each of the specified inputs and writes them to the standard output. If more than a single input is specified and the -q option is not specified, each file is preceded by a header consisting of the string "==> XXX <==" where "XXX" is the input's string representation.

Parameters:

options - Options for the head command.

count - The first count lines of each input file are copied to standard output, starting from 1 (characters instead of lines if the -c option is specified). Must be a non-negative integer or an exception is thrown. If count is greater than the number number of lines (characters) in the input, the application will not error and send the whole file to the output.

inputs - The inputs to be filtered.

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