org.unix4j.unix.ls

Class LsArguments

java.lang.Object

org.unix4j.unix.ls.LsArguments

All Implemented Interfaces:

Arguments<LsArguments>

public final class LsArguments
extends Object
implements Arguments<LsArguments>

Arguments and options for the ls command.

Constructor Summary

Constructors

Constructor and Description
LsArguments() Constructor to use if no options are specified.
LsArguments(LsOptions options) Constructor with option set containing the selected command options.
LsArguments(String... args) Constructor string arguments encoding options and arguments, possibly also containing variable expressions.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getArgs() Returns the <args> operand value: String arguments defining the options and operands for the command.
File[]	getFiles() Returns the <files> operand value: 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).
LsArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
LsOptions	getOptions() Returns the options set containing the selected command options.
String[]	getPaths() Returns the <paths> operand value: 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.
boolean	isAllFiles() Returns true if the --allFiles option is set.
boolean	isArgsSet() Returns true if the <args> operand has been set.
boolean	isFilesSet() Returns true if the <files> operand has been set.
boolean	isHumanReadable() Returns true if the --humanReadable option is set.
boolean	isLongFormat() Returns true if the --longFormat option is set.
boolean	isPathsSet() Returns true if the <paths> operand has been set.
boolean	isRecurseSubdirs() Returns true if the --recurseSubdirs option is set.
boolean	isReverseOrder() Returns true if the --reverseOrder option is set.
boolean	isTimeSorted() Returns true if the --timeSorted option is set.
void	setFiles(File... files) Sets <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).
void	setPaths(String... paths) Sets <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.
String	toString() Returns a string representation of the command arguments and options.

Methods inherited from class java.lang.Object

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

Constructor Detail

LsArguments

public LsArguments()

Constructor to use if no options are specified.

LsArguments

public LsArguments(LsOptions options)

Constructor with option set containing the selected command options.

Parameters:

options - the selected options

Throws:

NullPointerException - if the argument is null

LsArguments

public LsArguments(String... args)

Constructor string arguments encoding options and arguments, possibly also containing variable expressions.

Parameters:

args - string arguments for the command

Throws:

NullPointerException - if args is null

Method Detail

getOptions

public LsOptions getOptions()

Returns the options set containing the selected command options. Returns an empty options set if no option has been selected.

Returns:

set with the selected options

getForContext

public LsArguments getForContext(ExecutionContext context)

Description copied from interface: Arguments

Returns an arguments object for the given execution context with resolved variables if necessary and possible. If variables are defined in this arguments instance, a new arguments instance is created with values instead of variables for those variables that are defined in the specified context object. If this arguments instance uses no variables, this arguments instance is simply returned.

If variables are present, they are resolved if such a variable is defined in the VariableContext returned by context.getVariableContext(). Values are converted if necessary with the ValueConverters returned by context.getValueConverterFor(Class).

Specified by:

getForContext in interface Arguments<LsArguments>

Parameters:

context - the execution context providing access to variables and converters

Returns:

an arguments object with resolved variables where possible

getFiles

public File[] getFiles()

Returns the <files> operand value: 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 <files> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isFilesSet

public boolean isFilesSet()

Returns true if the <files> operand has been set.

Note that this method returns true even if null was passed to the setFiles(java.io.File[]) method.

Returns:

true if the setter for the <files> operand has been called at least once

setFiles

public void setFiles(File... files)

Sets <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).

Parameters:

files - the value for the <files> operand

getPaths

public String[] getPaths()

Returns the <paths> operand value: 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 <paths> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isPathsSet

public boolean isPathsSet()

Returns true if the <paths> operand has been set.

Note that this method returns true even if null was passed to the setPaths(String[]) method.

Returns:

true if the setter for the <paths> operand has been called at least once

setPaths

public void setPaths(String... paths)

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

Parameters:

paths - the value for the <paths> operand

getArgs

public String[] getArgs()

Returns the <args> operand value: 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 <args> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isArgsSet

public boolean isArgsSet()

Returns true if the <args> operand has been set.

Returns:

true if the setter for the <args> operand has been called at least once

isAllFiles

public boolean isAllFiles()

Returns true if the --allFiles option is set. The option is also known as -a option.

Description: Lists all files in the given directory, including hidden files (those whose names start with \".\" in Unix). By default, these files are excluded from the list.

Returns:

true if the --allFiles or -a option is set

isHumanReadable

public boolean isHumanReadable()

Returns true if the --humanReadable option is set. The option is also known as -h option.

Description: Print sizes in human readable format. (e.g., 1K, 234M, 2G, etc.)

Returns:

true if the --humanReadable or -h option is set

isLongFormat

public boolean isLongFormat()

Returns true if the --longFormat option is set. The option is also known as -l option.

Description: Long format, displaying file types, permissions, number of hard links, owner, group, size, date, and filename.

Returns:

true if the --longFormat or -l option is set

isRecurseSubdirs

public boolean isRecurseSubdirs()

Returns true if the --recurseSubdirs option is set. The option is also known as -R option.

Description: Recursively lists subdirectories encountered.

Returns:

true if the --recurseSubdirs or -R option is set

isReverseOrder

public boolean isReverseOrder()

Returns true if the --reverseOrder option is set. The option is also known as -r option.

Description: Reverses the order of the sort to get reverse collating sequence or oldest first.

Returns:

true if the --reverseOrder or -r option is set

isTimeSorted

public boolean isTimeSorted()

Returns true if the --timeSorted option is set. The option is also known as -t option.

Description: Sorts with the primary key being time modified (most recently modified first) and the secondary key being filename in the collating sequence.

Returns:

true if the --timeSorted or -t option is set

toString

public String toString()

Description copied from interface: Arguments

Returns a string representation of the command arguments and options.

Specified by:

toString in interface Arguments<LsArguments>

Overrides:

toString in class Object

Returns:

a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"