HeadFactory (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- org.unix4j.unix.head.HeadFactory

All Implemented Interfaces:

CommandInterface<HeadCommand>, Head.Interface<HeadCommand>
```
public final class HeadFactory
extends Object
implements Head.Interface<HeadCommand>
```
Factory for the head command returning a new command instance from every signature method.

Field Summary

Fields
Modifier and Type Field and Description

static HeadFactory INSTANCE
The singleton instance of this factory.

Fields
Modifier and Type	Field and Description
`static HeadFactory`	`INSTANCE` The singleton instance of this factory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HeadCommand`	`head()` Reads the first 10 lines from the standard input and writes them to the standard output.
`HeadCommand`	`head(File... files)` Reads the first 10 lines from each of the specified files and writes them to the standard output.
`HeadCommand`	`head(HeadOptions options, long count)` Reads the first `count` lines or characters from the standard input and writes them to the standard output.
`HeadCommand`	`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.
`HeadCommand`	`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.
`HeadCommand`	`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.
`HeadCommand`	`head(Input... inputs)` Reads the first 10 lines from each of the specified inputs and writes them to the standard output.
`HeadCommand`	`head(long count)` Reads the first `count` lines from the standard input and writes them to the standard output.
`HeadCommand`	`head(long count, File... files)` Reads the first `count` lines from each of the specified files and writes them to the standard output.
`HeadCommand`	`head(long count, Input... inputs)` Reads the first `count` lines from each of the specified inputs and writes them to the standard output.
`HeadCommand`	`head(long count, String... paths)` Reads the first `count` lines from each of the specified files and writes them to the standard output.
`HeadCommand`	`head(String... args)` Reads the first n lines from each of the files specified and writes them to the standard output.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final HeadFactory INSTANCE
```
    The singleton instance of this factory.
- Method Detail
  - head
```
public HeadCommand head()
```
    Description copied from interface: Head.Interface
    
    Reads the first 10 lines from the standard input and writes them to the standard output.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(String... args)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(long count)
```
    Description copied from interface: Head.Interface
    
    Reads the first count lines from the standard input and writes them to the standard output.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(HeadOptions options,
                        long count)
```
    Description copied from interface: Head.Interface
    
    Reads the first count lines or characters from the standard input and writes them to the standard output.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(File... files)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(Input... inputs)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(long count,
                        File... files)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(long count,
                        String... paths)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(long count,
                        Input... inputs)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(HeadOptions options,
                        long count,
                        File... files)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(HeadOptions options,
                        long count,
                        String... paths)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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
```
public HeadCommand head(HeadOptions options,
                        long count,
                        Input... inputs)
```
    Description copied from interface: Head.Interface
    
    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.
    
    Specified by:
    
    head in interface Head.Interface<HeadCommand>
    
    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

Class HeadFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Method Detail

head

head

head

head

head

head

head

head

head

head

head

head