CLOptionDescriptor 5.6.3 API

All Implemented Interfaces:
```
public final class CLOptionDescriptor

                    
```
Basic class describing an type of option. Typically, one creates a static array of CLOptionDescriptors, and passes it to CLArgsParser.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static int`	`ARGUMENT_REQUIRED`
`public final static int`	`ARGUMENT_OPTIONAL`
`public final static int`	`ARGUMENT_DISALLOWED`
`public final static int`	`ARGUMENTS_REQUIRED_2`
`public final static int`	`DUPLICATES_ALLOWED`
`public final int`	`id`
`public final int`	`flags`
`public final String`	`name`
`public final String`	`description`

Constructor Summary

Constructors
Constructor	Description
`CLOptionDescriptor(String name, int flags, int id, String description)`	Constructor.
`CLOptionDescriptor(String name, int flags, int id, String description, Array<CLOptionDescriptor> incompatible)`	Constructor.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final int`	`getId()`	Retrieve the id for option.
`final int`	`getFlags()`	Retrieve flags about option.
`final String`	`getName()`	Retrieve name of option which is also text for long option.
`final String`	`getDescription()`	Retrieve textual description.
`final String`	`toString()`

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

- Constructor Detail
  - CLOptionDescriptor
```
CLOptionDescriptor(String name, int flags, int id, String description)
```
    Constructor.
    
    Parameters:
    
    name - the name/long option
    
    flags - the flags
    
    id - the id/character option
    
    description - description of option usage
  - CLOptionDescriptor
```
CLOptionDescriptor(String name, int flags, int id, String description, Array<CLOptionDescriptor> incompatible)
```
    Constructor.
    
    Parameters:
    
    name - the name/long option
    
    flags - the flags
    
    id - the id/character option
    
    description - description of option usage
    
    incompatible - descriptors for incompatible options
- Method Detail
  - getId
```
 final int getId()
```
    Retrieve the id for option. The id is also the character if using single character options.
    
    Returns:
    
    the id
  - getFlags
```
 final int getFlags()
```
    Retrieve flags about option. Flags include details such as whether it allows parameters etc.
    
    Returns:
    
    the flags
  - getName
```
 final String getName()
```
    Retrieve name of option which is also text for long option.
    
    Returns:
    
    name/long option
  - getDescription
```
 final String getDescription()
```
    Retrieve textual description.
    
    Returns:
    
    the description
  - toString
```
 final String toString()
```