org.unix4j.unix

Interface Ls.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, LsFactory

Enclosing class:

Ls

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

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

Method Summary

Methods

Modifier and Type	Method and Description
R	ls() Lists all files and directories in the user's current working directory and writes them to the output.
R	ls(File... files) Prints the name of the given files and lists all files contained in directories for every directory in files.
R	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.
R	ls(LsOptions options, File... files) Prints the name of the given files and lists all files contained in directories for every directory in files.
R	ls(LsOptions options, String... paths) Prints the name of the given files and lists all files contained in directories for every directory in files.
R	ls(String... args) Prints the name of the specified files and lists all files contained in directories for every directory in those files.

Method Detail

ls

R ls()

Lists all files and directories in the user's current working directory and writes them 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

ls

R ls(String... args)

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.

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

R ls(File... files)

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

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

R 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.

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

R ls(LsOptions options,
   File... files)

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.

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

R ls(LsOptions options,
   String... paths)

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.

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