CLOption 5.6.3 API

All Implemented Interfaces:


public final class CLOption

Basic class describing an instance of option.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static int`	`TEXT_ARGUMENT`
`public CLOptionDescriptor`	`descriptor`

Constructor Summary

Constructors
Constructor	Description
`CLOption(CLOptionDescriptor descriptor)`	Constructor taking an descriptor
`CLOption(String argument)`	Constructor taking argument for option.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final CLOptionDescriptor`	`getDescriptor()`
`final String`	`getArgument()`	Retrieve argument to option if it takes arguments.
`final String`	`getArgument(int index)`	Retrieve indexed argument to option if it takes arguments.
`final void`	`addArgument(String argument)`	Mutator of Argument property.
`final int`	`getArgumentCount()`	Get number of arguments.
`final String`	`toString()`	Convert to String.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CLOption
```
CLOption(CLOptionDescriptor descriptor)
```
    Constructor taking an descriptor
    
    Parameters:
    
    descriptor - the descriptor iff null, will default to a "text argument" descriptor.
  - CLOption
```
CLOption(String argument)
```
    Constructor taking argument for option.
    
    Parameters:
    
    argument - the argument
- Method Detail
  - getDescriptor
```
 final CLOptionDescriptor getDescriptor()
```
  - getArgument
```
 final String getArgument()
```
    Retrieve argument to option if it takes arguments.
    
    Returns:
    
    the (first) argument
  - getArgument
```
 final String getArgument(int index)
```
    Retrieve indexed argument to option if it takes arguments.
    
    Parameters:
    
    index - The argument index, from 0 to getArgumentCount-1.
    
    Returns:
    
    the argument
  - addArgument
```
 final void addArgument(String argument)
```
    Mutator of Argument property.
    
    Parameters:
    
    argument - the argument
  - getArgumentCount
```
 final int getArgumentCount()
```
    Get number of arguments.
    
    Returns:
    
    the number of arguments
  - toString
```
 final String toString()
```
    Convert to String.
    
    Returns:
    
    the string value