SortArguments (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- org.unix4j.unix.sort.SortArguments

All Implemented Interfaces:

Arguments<SortArguments>
```
public final class SortArguments
extends Object
implements Arguments<SortArguments>
```
Arguments and options for the sort command.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getArgs()` Returns the `<args>` operand value: String arguments defining the options and operands for the command.
`Comparator<? super Line>`	`getComparator()` Returns the `<comparator>` operand value: The comparator to use for the line comparisons.
`File[]`	`getFiles()` Returns the `<files>` operand value: The files to be sorted or merged; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
`SortArguments`	`getForContext(ExecutionContext context)` Returns an arguments object for the given execution context with resolved variables if necessary and possible.
`Input[]`	`getInputs()` Returns the `<inputs>` operand value: The inputs to be sorted or merged.
`SortOptions`	`getOptions()` Returns the options set containing the selected command options.
`String[]`	`getPaths()` Returns the `<paths>` operand value: Path names of the files to be sorted, merged, or checked; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
`boolean`	`isArgsSet()` Returns true if the `<args>` operand has been set.
`boolean`	`isCheck()` Returns true if the `--check` option is set.
`boolean`	`isComparatorSet()` Returns true if the `<comparator>` operand has been set.
`boolean`	`isDictionaryOrder()` Returns true if the `--dictionaryOrder` option is set.
`boolean`	`isFilesSet()` Returns true if the `<files>` operand has been set.
`boolean`	`isGeneralNumericSort()` Returns true if the `--generalNumericSort` option is set.
`boolean`	`isHumanNumericSort()` Returns true if the `--humanNumericSort` option is set.
`boolean`	`isIgnoreCase()` Returns true if the `--ignoreCase` option is set.
`boolean`	`isIgnoreLeadingBlanks()` Returns true if the `--ignoreLeadingBlanks` option is set.
`boolean`	`isInputsSet()` Returns true if the `<inputs>` operand has been set.
`boolean`	`isMerge()` Returns true if the `--merge` option is set.
`boolean`	`isMonthSort()` Returns true if the `--monthSort` option is set.
`boolean`	`isNumericSort()` Returns true if the `--numericSort` option is set.
`boolean`	`isPathsSet()` Returns true if the `<paths>` operand has been set.
`boolean`	`isReverse()` Returns true if the `--reverse` option is set.
`boolean`	`isUnique()` Returns true if the `--unique` option is set.
`boolean`	`isVersionSort()` Returns true if the `--versionSort` option is set.
`void`	`setComparator(Comparator<? super Line> comparator)` Sets `<comparator>`: The comparator to use for the line comparisons.
`void`	`setFiles(File... files)` Sets `<files>`: The files to be sorted or merged; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
`void`	`setInputs(Input... inputs)` Sets `<inputs>`: The inputs to be sorted or merged.
`void`	`setPaths(String... paths)` Sets `<paths>`: Path names of the files to be sorted, merged, or checked; 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
  - SortArguments
```
public SortArguments()
```
    Constructor to use if no options are specified.
  - SortArguments
```
public SortArguments(SortOptions options)
```
    Constructor with option set containing the selected command options.
    
    Parameters:
    
    options - the selected options
    
    Throws:
    
    NullPointerException - if the argument is null
  - SortArguments
```
public SortArguments(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 SortOptions 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 SortArguments 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<SortArguments>
    
    Parameters:
    
    context - the execution context providing access to variables and converters
    
    Returns:
    
    an arguments object with resolved variables where possible
  - getPaths
```
public String[] getPaths()
```
    Returns the <paths> operand value: Path names of the files to be sorted, merged, or checked; 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>: Path names of the files to be sorted, merged, or checked; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
    
    Parameters:
    
    paths - the value for the <paths> operand
  - getFiles
```
public File[] getFiles()
```
    Returns the <files> operand value: The files to be sorted or merged; relative paths are not resolved (use the string paths 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 to be sorted or merged; relative paths are not resolved (use the string paths argument to enable relative path resolving based on the current working directory).
    
    Parameters:
    
    files - the value for the <files> operand
  - getInputs
```
public Input[] getInputs()
```
    Returns the <inputs> operand value: The inputs to be sorted or merged.
    
    Returns:
    
    the <inputs> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isInputsSet
```
public boolean isInputsSet()
```
    Returns true if the <inputs> operand has been set.
    Note that this method returns true even if null was passed to the setInputs(org.unix4j.io.Input[]) method.
    
    Returns:
    
    true if the setter for the <inputs> operand has been called at least once
  - setInputs
```
public void setInputs(Input... inputs)
```
    Sets <inputs>: The inputs to be sorted or merged.
    
    Parameters:
    
    inputs - the value for the <inputs> operand
  - getComparator
```
public Comparator<? super Line> getComparator()
```
    Returns the <comparator> operand value: The comparator to use for the line comparisons.
    
    Returns:
    
    the <comparator> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isComparatorSet
```
public boolean isComparatorSet()
```
    Returns true if the <comparator> operand has been set.
    Note that this method returns true even if null was passed to the setComparator(java.util.Comparator) method.
    
    Returns:
    
    true if the setter for the <comparator> operand has been called at least once
  - setComparator
```
public void setComparator(Comparator<? super Line> comparator)
```
    Sets <comparator>: The comparator to use for the line comparisons.
    
    Parameters:
    
    comparator - the value for the <comparator> 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. "--comparator" for a subsequent comparator 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
  - isCheck
```
public boolean isCheck()
```
    Returns true if the --check option is set. The option is also known as -c option.
    Description: Checks that the single input file is ordered as specified by the arguments and the collating sequence of the current locale. No output is produced; only the exit code is affected.
    
    Returns:
    
    true if the --check or -c option is set
  - isMerge
```
public boolean isMerge()
```
    Returns true if the --merge option is set. The option is also known as -m option.
    Description: Merge only; the input file are assumed to be already sorted.
    
    Returns:
    
    true if the --merge or -m option is set
  - isUnique
```
public boolean isUnique()
```
    Returns true if the --unique option is set. The option is also known as -u option.
    Description: Unique: suppress all but one in each set of lines having equal keys. If used with the -c option, checks that there are no lines with duplicate keys, in addition to checking that the input file is sorted.
    
    Returns:
    
    true if the --unique or -u option is set
  - isIgnoreLeadingBlanks
```
public boolean isIgnoreLeadingBlanks()
```
    Returns true if the --ignoreLeadingBlanks option is set. The option is also known as -b option.
    Description: Ignore leading blanks. (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --ignoreLeadingBlanks or -b option is set
  - isDictionaryOrder
```
public boolean isDictionaryOrder()
```
    Returns true if the --dictionaryOrder option is set. The option is also known as -d option.
    Description: Consider only blanks and alphanumeric characters. (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --dictionaryOrder or -d option is set
  - isIgnoreCase
```
public boolean isIgnoreCase()
```
    Returns true if the --ignoreCase option is set. The option is also known as -f option.
    Description: Consider all lowercase characters that have uppercase equivalents to be the uppercase equivalent for the purposes of comparison. (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --ignoreCase or -f option is set
  - isNumericSort
```
public boolean isNumericSort()
```
    Returns true if the --numericSort option is set. The option is also known as -n option.
    Description: Sort numerically; the number begins each line and consists of optional blanks, an optional minus sign, and zero or more digits possibly separated by thousands separators, optionally followed by a decimal-point character and zero or more digits. An empty number is treated as '0'. The current local specifies the decimal-point character and thousands separator.
    Comparison is exact; there is no rounding error.
    Neither a leading '+' nor exponential notation is recognized. To compare such strings numerically, use the -genericNumericSort (-g) option.
    (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --numericSort or -n option is set
  - isGeneralNumericSort
```
public boolean isGeneralNumericSort()
```
    Returns true if the --generalNumericSort option is set. The option is also known as -g option.
    Description: Sort numerically, using the standard Double.parseDouble(String) function to convert a trimmed line to a double-precision floating point number. This allows floating point numbers to be specified in scientific notation, like 1.0e-34 and 10e100.
    Uses the following collating sequence: Lines that cannot be parsed because they do not represent valid double values (in alpha-numeric order); "-Infinity"; finite numbers in ascending numeric order (with -0 < +0); "Infinity"; "NaN".
    This option is usually slower than -numeric-sort (-n) and it can lose information when converting to floating point.
    (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --generalNumericSort or -g option is set
  - isHumanNumericSort
```
public boolean isHumanNumericSort()
```
    Returns true if the --humanNumericSort option is set. The option is also known as -h option.
    Description: Sort numerically, first by numeric sign (negative, zero, or positive); then by SI suffix (either empty, or 'k' or 'K', or one of 'MGTPEZY', in that order); and finally by numeric value. For example, '1023M' sorts before '1G' because 'M' (mega) precedes 'G' (giga) as an SI suffix.
    This option sorts values that are consistently scaled to the nearest suffix, regardless of whether suffixes denote powers of 1000 or 1024, and it therefore sorts the output of any single invocation of the ls command that are invoked with the --human-readable option.
    The syntax for numbers is the same as for the --numericSort (-n) option; the SI suffix must immediately follow the number.
    (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --humanNumericSort or -h option is set
  - isMonthSort
```
public boolean isMonthSort()
```
    Returns true if the --monthSort option is set. The option is also known as -M option.
    Description: An initial string, consisting of any amount of blanks, followed by a month name abbreviation, is folded to UPPER case and compared in the order: (unknown) < 'JAN' < ... < 'DEC'. The current locale determines the month spellings.
    
    Returns:
    
    true if the --monthSort or -M option is set
  - isVersionSort
```
public boolean isVersionSort()
```
    Returns true if the --versionSort option is set. The option is also known as -V option.
    Description: Sort by version name and number. It behaves like a standard sort, except that each sequence of decimal digits is treated numerically as an index/version number.
    (This option is ignored if a comparator operand is present).
    
    Returns:
    
    true if the --versionSort or -V option is set
  - isReverse
```
public boolean isReverse()
```
    Returns true if the --reverse option is set. The option is also known as -r option.
    Description: Reverse the sense of comparisons.
    
    Returns:
    
    true if the --reverse or -r 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<SortArguments>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"

Class SortArguments

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SortArguments

SortArguments

SortArguments

Method Detail

getOptions

getForContext

getPaths

isPathsSet

setPaths

getFiles

isFilesSet

setFiles

getInputs

isInputsSet

setInputs

getComparator

isComparatorSet

setComparator

getArgs

isArgsSet

isCheck

isMerge

isUnique

isIgnoreLeadingBlanks

isDictionaryOrder

isIgnoreCase

isNumericSort

isGeneralNumericSort

isHumanNumericSort

isMonthSort

isVersionSort

isReverse

toString