CatArguments (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- org.unix4j.unix.cat.CatArguments

All Implemented Interfaces:

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

Constructor Summary

Constructors
Constructor and Description
`CatArguments()` Constructor to use if no options are specified.
`CatArguments(CatOptions options)` Constructor with option set containing the selected command options.
`CatArguments(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 file operands for the command.
`File[]`	`getFiles()` Returns the `<files>` operand value: The input files to be printed; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).
`CatArguments`	`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 printed.
`CatOptions`	`getOptions()` Returns the options set containing the selected command options.
`String[]`	`getPaths()` Returns the `<paths>` operand value: Path names of the input files to be printed; 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`	`isFilesSet()` Returns true if the `<files>` operand has been set.
`boolean`	`isInputsSet()` Returns true if the `<inputs>` operand has been set.
`boolean`	`isNumberLines()` Returns true if the `--numberLines` option is set.
`boolean`	`isNumberNonBlankLines()` Returns true if the `--numberNonBlankLines` option is set.
`boolean`	`isPathsSet()` Returns true if the `<paths>` operand has been set.
`boolean`	`isSqueezeEmptyLines()` Returns true if the `--squeezeEmptyLines` option is set.
`void`	`setFiles(File... files)` Sets `<files>`: The input files to be printed; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).
`void`	`setInputs(Input... inputs)` Sets `<inputs>`: The inputs to be printed.
`void`	`setPaths(String... paths)` Sets `<paths>`: Path names of the input files to be printed; 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
  - CatArguments
```
public CatArguments()
```
    Constructor to use if no options are specified.
  - CatArguments
```
public CatArguments(CatOptions options)
```
    Constructor with option set containing the selected command options.
    
    Parameters:
    
    options - the selected options
    
    Throws:
    
    NullPointerException - if the argument is null
  - CatArguments
```
public CatArguments(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 CatOptions 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 CatArguments 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<CatArguments>
    
    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 input files to be printed; 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 input files to be printed; 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: Path names of the input files to be printed; 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 input files to be printed; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
    
    Parameters:
    
    paths - the value for the <paths> operand
  - getInputs
```
public Input[] getInputs()
```
    Returns the <inputs> operand value: The inputs to be printed.
    
    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 printed.
    
    Parameters:
    
    inputs - the value for the <inputs> operand
  - getArgs
```
public String[] getArgs()
```
    Returns the <args> operand value: String arguments defining the options and file operands for the command. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). File arguments are expanded if wildcards are used.
    
    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
  - isNumberNonBlankLines
```
public boolean isNumberNonBlankLines()
```
    Returns true if the --numberNonBlankLines option is set. The option is also known as -b option.
    Description: Number the non-blank output lines, starting at 1.
    
    Returns:
    
    true if the --numberNonBlankLines or -b option is set
  - isNumberLines
```
public boolean isNumberLines()
```
    Returns true if the --numberLines option is set. The option is also known as -n option.
    Description: Number the output lines, starting at 1.
    
    Returns:
    
    true if the --numberLines or -n option is set
  - isSqueezeEmptyLines
```
public boolean isSqueezeEmptyLines()
```
    Returns true if the --squeezeEmptyLines option is set. The option is also known as -s option.
    Description: Squeeze multiple adjacent empty lines, causing the output to be single spaced.
    
    Returns:
    
    true if the --squeezeEmptyLines or -s 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<CatArguments>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"

Class CatArguments

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CatArguments

CatArguments

CatArguments

Method Detail

getOptions

getForContext

getFiles

isFilesSet

setFiles

getPaths

isPathsSet

setPaths

getInputs

isInputsSet

setInputs

getArgs

isArgsSet

isNumberNonBlankLines

isNumberLines

isSqueezeEmptyLines

toString