SimpleCommandLineParser.Option (Integrity Test Framework - Javadoc 23.0.0-SNAPSHOT API)

java.lang.Object
- de.gebit.integrity.runner.console.SimpleCommandLineParser.Option

Direct Known Subclasses:

SimpleCommandLineParser.BooleanOption, SimpleCommandLineParser.ValueOption

Enclosing class:

SimpleCommandLineParser
```
public abstract static class SimpleCommandLineParser.Option
extends java.lang.Object
```
Base class for command line options.

Author:

Rene Schneider - initial API and implementation

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`Option(java.lang.String aShortName, java.lang.String aLongName, java.lang.String aDescription, java.lang.String aCommandLine)`	Creates a new Option.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getCommandLine()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getHelpLine()`	Returns the line for the parameter help.
`java.lang.String`	`getLongName()`
`java.lang.String`	`getShortName()`
`protected boolean`	`matches(java.lang.String aParameter)`	Checks whether this matches a given parameter.

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

- Constructor Detail
  - Option
```
protected Option(java.lang.String aShortName,
                 java.lang.String aLongName,
                 java.lang.String aDescription,
                 java.lang.String aCommandLine)
```
    Creates a new Option.
    
    Parameters:
    
    aShortName - The short name of the option. Usually just one character.
    
    aLongName - The long name of the option, generelly a comprehendable, but not-too-long string.
    
    aDescription - The command line help string for this option.
    
    aCommandLine - The description for the help.
- Method Detail
  - matches
```
protected boolean matches(java.lang.String aParameter)
```
    Checks whether this matches a given parameter.
    
    Parameters:
    
    aParameter - the parameter
    
    Returns:
    
    true if a match is found, false otherwise
  - getShortName
```
public java.lang.String getShortName()
```
  - getLongName
```
public java.lang.String getLongName()
```
  - getDescription
```
public java.lang.String getDescription()
```
  - getCommandLine
```
public java.lang.String getCommandLine()
```
  - getHelpLine
```
public java.lang.String getHelpLine()
```
    Returns the line for the parameter help.