CutArguments (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- org.unix4j.unix.cut.CutArguments

All Implemented Interfaces:

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

Constructor Summary

Constructors
Constructor and Description
`CutArguments()` Constructor to use if no options are specified.
`CutArguments(CutOptions options)` Constructor with option set containing the selected command options.
`CutArguments(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.
`String`	`getDelimiter()` Returns the `<delimiter>` operand value (variables are NOT resolved): use as the output delimiter the default is to use the input delimiter
`String`	`getDelimiter(ExecutionContext context)` Returns the `<delimiter>` (variables are resolved): use as the output delimiter the default is to use the input delimiter
`CutArguments`	`getForContext(ExecutionContext context)` Returns an arguments object for the given execution context with resolved variables if necessary and possible.
`int[]`	`getIndexes()` Returns the `<indexes>` operand value: select these chars/field based on the given indexes.
`CutOptions`	`getOptions()` Returns the options set containing the selected command options.
`char`	`getOutputDelimiter()` Returns the `<outputDelimiter>` operand value: use as the output delimiter the default is to use the input delimiter
`Range`	`getRange()` Returns the `<range>` operand value: select only these fields
`boolean`	`isArgsSet()` Returns true if the `<args>` operand has been set.
`boolean`	`isChars()` Returns true if the `--chars` option is set.
`boolean`	`isDelimiterSet()` Returns true if the `<delimiter>` operand has been set.
`boolean`	`isFields()` Returns true if the `--fields` option is set.
`boolean`	`isIndexesSet()` Returns true if the `<indexes>` operand has been set.
`boolean`	`isOutputDelimiterSet()` Returns true if the `<outputDelimiter>` operand has been set.
`boolean`	`isRangeSet()` Returns true if the `<range>` operand has been set.
`void`	`setDelimiter(String delimiter)` Sets `<delimiter>`: use as the output delimiter the default is to use the input delimiter
`void`	`setIndexes(int... indexes)` Sets `<indexes>`: select these chars/field based on the given indexes.
`void`	`setOutputDelimiter(char outputDelimiter)` Sets `<outputDelimiter>`: use as the output delimiter the default is to use the input delimiter
`void`	`setRange(Range range)` Sets `<range>`: select only these fields
`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
  - CutArguments
```
public CutArguments()
```
    Constructor to use if no options are specified.
  - CutArguments
```
public CutArguments(CutOptions options)
```
    Constructor with option set containing the selected command options.
    
    Parameters:
    
    options - the selected options
    
    Throws:
    
    NullPointerException - if the argument is null
  - CutArguments
```
public CutArguments(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 CutOptions 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 CutArguments 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<CutArguments>
    
    Parameters:
    
    context - the execution context providing access to variables and converters
    
    Returns:
    
    an arguments object with resolved variables where possible
  - getDelimiter
```
public String getDelimiter()
```
    Returns the <delimiter> operand value (variables are NOT resolved): use as the output delimiter the default is to use the input delimiter
    
    Returns:
    
    the <delimiter> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getDelimiter(ExecutionContext)
  - getDelimiter
```
public String getDelimiter(ExecutionContext context)
```
    Returns the <delimiter> (variables are resolved): use as the output delimiter the default is to use the input delimiter
    
    Parameters:
    
    context - the execution context used to resolve variables
    
    Returns:
    
    the <delimiter> operand value after resolving variables
    
    Throws:
    
    IllegalStateException - if this operand has never been set
    
    See Also:
    
    getDelimiter()
  - isDelimiterSet
```
public boolean isDelimiterSet()
```
    Returns true if the <delimiter> operand has been set.
    Note that this method returns true even if null was passed to the setDelimiter(String) method.
    
    Returns:
    
    true if the setter for the <delimiter> operand has been called at least once
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    Sets <delimiter>: use as the output delimiter the default is to use the input delimiter
    
    Parameters:
    
    delimiter - the value for the <delimiter> operand
  - getOutputDelimiter
```
public char getOutputDelimiter()
```
    Returns the <outputDelimiter> operand value: use as the output delimiter the default is to use the input delimiter
    
    Returns:
    
    the <outputDelimiter> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isOutputDelimiterSet
```
public boolean isOutputDelimiterSet()
```
    Returns true if the <outputDelimiter> operand has been set.
    Note that this method returns true even if null was passed to the setOutputDelimiter(char) method.
    
    Returns:
    
    true if the setter for the <outputDelimiter> operand has been called at least once
  - setOutputDelimiter
```
public void setOutputDelimiter(char outputDelimiter)
```
    Sets <outputDelimiter>: use as the output delimiter the default is to use the input delimiter
    
    Parameters:
    
    outputDelimiter - the value for the <outputDelimiter> operand
  - getIndexes
```
public int[] getIndexes()
```
    Returns the <indexes> operand value: select these chars/field based on the given indexes. Indexes are 1 based. i.e. the first character/field on a line has an index of 1.
    
    Returns:
    
    the <indexes> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isIndexesSet
```
public boolean isIndexesSet()
```
    Returns true if the <indexes> operand has been set.
    Note that this method returns true even if null was passed to the setIndexes(int[]) method.
    
    Returns:
    
    true if the setter for the <indexes> operand has been called at least once
  - setIndexes
```
public void setIndexes(int... indexes)
```
    Sets <indexes>: select these chars/field based on the given indexes. Indexes are 1 based. i.e. the first character/field on a line has an index of 1.
    
    Parameters:
    
    indexes - the value for the <indexes> operand
  - getRange
```
public Range getRange()
```
    Returns the <range> operand value: select only these fields
    
    Returns:
    
    the <range> operand value (variables are not resolved)
    
    Throws:
    
    IllegalStateException - if this operand has never been set
  - isRangeSet
```
public boolean isRangeSet()
```
    Returns true if the <range> operand has been set.
    Note that this method returns true even if null was passed to the setRange(org.unix4j.util.Range) method.
    
    Returns:
    
    true if the setter for the <range> operand has been called at least once
  - setRange
```
public void setRange(Range range)
```
    Sets <range>: select only these fields
    
    Parameters:
    
    range - the value for the <range> 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 "--range" operand have to be prefixed with the operand name (e.g. "--indexes" for subsequent index operand values).
    
    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
  - isChars
```
public boolean isChars()
```
    Returns true if the --chars option is set. The option is also known as -c option.
    Description: The list specifies character positions.
    
    Returns:
    
    true if the --chars or -c option is set
  - isFields
```
public boolean isFields()
```
    Returns true if the --fields option is set. The option is also known as -f option.
    Description: The list specifies fields, separated in the input by the field delimiter character (see the -d option.) Output fields are separated by a single occurrence of the field delimiter character.
    
    Returns:
    
    true if the --fields or -f 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<CutArguments>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"

Class CutArguments

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CutArguments

CutArguments

CutArguments

Method Detail

getOptions

getForContext

getDelimiter

getDelimiter

isDelimiterSet

setDelimiter

getOutputDelimiter

isOutputDelimiterSet

setOutputDelimiter

getIndexes

isIndexesSet

setIndexes

getRange

isRangeSet

setRange

getArgs

isArgsSet

isChars

isFields

toString