org.unix4j.unix.ls

Class LsFactory

java.lang.Object

org.unix4j.unix.ls.LsFactory

All Implemented Interfaces:

CommandInterface<LsCommand>, Ls.Interface<LsCommand>

public final class LsFactory
extends Object
implements Ls.Interface<LsCommand>

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
LsCommand	ls() Lists all files and directories in the user's current working directory and writes them to the output.
LsCommand	ls(File... files) Prints the name of the given files and lists all files contained in directories for every directory in files.
LsCommand	ls(LsOptions options) Lists all files and directories in the user's current working directory and writes them to the output using the given options specifying the details of the output format.
LsCommand	ls(LsOptions options, File... files) Prints the name of the given files and lists all files contained in directories for every directory in files.
LsCommand	ls(LsOptions options, String... paths) Prints the name of the given files and lists all files contained in directories for every directory in files.
LsCommand	ls(String... args) Prints the name of the specified files and lists all files contained in directories for every directory in those files.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final LsFactory INSTANCE

The singleton instance of this factory.

Method Detail

ls

public LsCommand ls()

Description copied from interface: Ls.Interface

Lists all files and directories in the user's current working directory and writes them to the output.

Specified by:

ls in interface Ls.Interface<LsCommand>

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

ls

public LsCommand ls(String... args)

Description copied from interface: Ls.Interface

Prints the name of the specified files and lists all files contained in directories for every directory in those files.

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:

ls in interface Ls.Interface<LsCommand>

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

ls

public LsCommand ls(File... files)

Description copied from interface: Ls.Interface

Prints the name of the given files and lists all files contained in directories for every directory in files.

Specified by:

ls in interface Ls.Interface<LsCommand>

Parameters:

files - The files or directories used as starting point for the listing; 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

ls

public LsCommand ls(LsOptions options)

Description copied from interface: Ls.Interface

Lists all files and directories in the user's current working directory and writes them to the output using the given options specifying the details of the output format.

Specified by:

ls in interface Ls.Interface<LsCommand>

Parameters:

options - The options defining the output format.

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

ls

public LsCommand ls(LsOptions options,
                    File... files)

Description copied from interface: Ls.Interface

Prints the name of the given files and lists all files contained in directories for every directory in files. The given options define the details of the output format.

Specified by:

ls in interface Ls.Interface<LsCommand>

Parameters:

options - The options defining the output format.

files - The files or directories used as starting point for the listing; 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

ls

public LsCommand ls(LsOptions options,
                    String... paths)

Description copied from interface: Ls.Interface

Prints the name of the given files and lists all files contained in directories for every directory in files. The given options define the details of the output format.

Specified by:

ls in interface Ls.Interface<LsCommand>

Parameters:

options - The options defining the output format.

paths - The files or directories used as starting point for the listing; 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