com.jmodule.def

Class Option

java.lang.Object

com.jmodule.def.Option

public class Option
extends java.lang.Object

Represents an option that affects a command's behavior. These are, by nature, optional and do not count as a parameter of a command. Each option is called by a unique single-char flag, signified by a dash (for example, -v).

Version:

1.3.1

Author:

Pierce Kelaita

Constructor Summary

Constructors

Constructor and Description
Option(char flag, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
Option	addReference(java.lang.String reference) Adds a possible reference to the option.
java.lang.String	getDescription()
java.lang.String	getFlag()
java.util.ArrayList<java.lang.String>	getReferences()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Option

public Option(char flag,
              java.lang.String description)

Method Detail

getReferences

public java.util.ArrayList<java.lang.String> getReferences()

getFlag

public java.lang.String getFlag()

getDescription

public java.lang.String getDescription()

addReference

public Option addReference(java.lang.String reference)

Adds a possible reference to the option. References are signaled by a double dash and can be multiple characters (for example, --verbose).

Parameters:

reference - String to reference option

Returns:

Instance of this option with added reference