LsOption (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<LsOption>
- - org.unix4j.unix.ls.LsOption

All Implemented Interfaces:: Serializable, Comparable<LsOption>, Iterable<LsOption>, Option, OptionSet<LsOption>, LsOptions

public enum LsOption
extends Enum<LsOption>
implements Option, LsOptions

Options for the ls command.

For most applications, it may be more convenient to use Ls.Options instead of the option constants defined here.

`-a`	`--allFiles`	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.
`-h`	`--humanReadable`	Print sizes in human readable format. (e.g., 1K, 234M, 2G, etc.)
`-l`	`--longFormat`	Long format, displaying file types, permissions, number of hard links, owner, group, size, date, and filename.
`-R`	`--recurseSubdirs`	Recursively lists subdirectories encountered.
`-r`	`--reverseOrder`	Reverses the order of the sort to get reverse collating sequence or oldest first.
`-t`	`--timeSorted`	Sorts with the primary key being time modified (most recently modified first) and the secondary key being filename in the collating sequence.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.unix4j.unix.ls.LsOptions
  LsOptions.Default

Enum Constant Summary

Enum Constants
Enum Constant and Description
`allFiles` Option `--allFiles`, `-a`: Lists all files in the given directory, including hidden files (those whose names start with \".\" in Unix).
`humanReadable` Option `--humanReadable`, `-h`: Print sizes in human readable format.
`longFormat` Option `--longFormat`, `-l`: Long format, displaying file types, permissions, number of hard links, owner, group, size, date, and filename.
`recurseSubdirs` Option `--recurseSubdirs`, `-R`: Recursively lists subdirectories encountered.
`reverseOrder` Option `--reverseOrder`, `-r`: Reverses the order of the sort to get reverse collating sequence or oldest first.
`timeSorted` Option `--timeSorted`, `-t`: Sorts with the primary key being time modified (most recently modified first) and the secondary key being filename in the collating sequence.

Field Summary
- Fields inherited from interface org.unix4j.unix.ls.LsOptions
  CONVERTER, EMPTY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`acronym()` Returns a one letter acronym for this option.
`EnumSet<LsOption>`	`asSet()` Returns a new set with `this` active option.
`static LsOption`	`findByAcronym(char acronym)` Returns the option with the given `acronym`, or `null` if no such option is found.
`boolean`	`isSet(LsOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<LsOption>`	`iterator()` Returns an immutable iterator returning o single element: `this` option.
`Class<LsOption>`	`optionType()` Returns the option type class, usually an enum.
`int`	`size()` Returns 1 as this is a set with a single element: `this` option
`boolean`	`useAcronymFor(LsOption option)` Returns true if the `acronym` should be used for the specified `option` in string representations.
`static LsOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LsOption[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.unix4j.option.Option
name

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Enum Constant Detail
  - allFiles
```
public static final LsOption allFiles
```
    Option --allFiles, -a: 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.
  - humanReadable
```
public static final LsOption humanReadable
```
    Option --humanReadable, -h: Print sizes in human readable format. (e.g., 1K, 234M, 2G, etc.)
  - longFormat
```
public static final LsOption longFormat
```
    Option --longFormat, -l: Long format, displaying file types, permissions, number of hard links, owner, group, size, date, and filename.
  - recurseSubdirs
```
public static final LsOption recurseSubdirs
```
    Option --recurseSubdirs, -R: Recursively lists subdirectories encountered.
  - reverseOrder
```
public static final LsOption reverseOrder
```
    Option --reverseOrder, -r: Reverses the order of the sort to get reverse collating sequence or oldest first.
  - timeSorted
```
public static final LsOption timeSorted
```
    Option --timeSorted, -t: Sorts with the primary key being time modified (most recently modified first) and the secondary key being filename in the collating sequence.
- Method Detail
  - values
```
public static LsOption[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (LsOption c : LsOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LsOption valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - optionType
```
public Class<LsOption> optionType()
```
    Description copied from interface: OptionSet
    
    Returns the option type class, usually an enum.
    
    Specified by:
    
    optionType in interface OptionSet<LsOption>
    
    Returns:
    
    the option type
  - findByAcronym
```
public static LsOption findByAcronym(char acronym)
```
    Returns the option with the given acronym, or null if no such option is found.
    
    Parameters:
    
    acronym - the option acronym
    
    Returns:
    
    the option with the given acronym or null if it is not found
  - acronym
```
public char acronym()
```
    Description copied from interface: Option
    
    Returns a one letter acronym for this option.
    
    Specified by:
    
    acronym in interface Option
    
    Returns:
    
    the acronym character used for this option.
  - isSet
```
public boolean isSet(LsOption option)
```
    Description copied from interface: OptionSet
    
    Returns true if the specified option is set and false otherwise
    
    Specified by:
    
    isSet in interface OptionSet<LsOption>
    
    Parameters:
    
    option - the option to test
    
    Returns:
    
    true if option is set in this OptionSet
  - asSet
```
public EnumSet<LsOption> asSet()
```
    Returns a new set with this active option.
    
    Specified by:
    
    asSet in interface OptionSet<LsOption>
    
    Returns:
    
    a new set containing this option
  - iterator
```
public Iterator<LsOption> iterator()
```
    Returns an immutable iterator returning o single element: this option.
    
    Specified by:
    
    iterator in interface Iterable<LsOption>
    
    Specified by:
    
    iterator in interface OptionSet<LsOption>
    
    Returns:
    
    an immutable iterator with this active option.
  - size
```
public int size()
```
    Returns 1 as this is a set with a single element: this option
    
    Specified by:
    
    size in interface OptionSet<LsOption>
    
    Returns:
    
    one
  - useAcronymFor
```
public boolean useAcronymFor(LsOption option)
```
    Returns true if the acronym should be used for the specified option in string representations.
    This method returns always true for all options.
    
    Specified by:
    
    useAcronymFor in interface OptionSet<LsOption>
    
    Parameters:
    
    option - the option of interest
    
    Returns:
    
    always true indicating that option acronyms should be used in string representations for all options

Enum LsOption

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.ls.LsOptions

Enum Constant Summary

Field Summary

Fields inherited from interface org.unix4j.unix.ls.LsOptions

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.unix4j.option.Option

Methods inherited from interface java.lang.Iterable

Enum Constant Detail

allFiles

humanReadable

longFormat

recurseSubdirs

reverseOrder

timeSorted

Method Detail

values

valueOf

optionType

findByAcronym

acronym

isSet

asSet

iterator

size

useAcronymFor