| java.lang.Object org.apache.commons.cli.avalon.CLOptionDescriptor
Method Summary | |
final public String | getDescription() Retrieve textual description. | final public int | getFlags() Retrieve flags about option. | final public int | getId() Retrieve the id for option. | final protected int[] | getIncompatible() Get the array of incompatible option ids. | final public String | getName() Retrieve name of option which is also text for long option. | final public String | toString() Convert to String. |
ARGUMENTS_REQUIRED_2 | final public static int ARGUMENTS_REQUIRED_2(Code) | | Flag to say this option requires 2 arguments
|
ARGUMENT_DISALLOWED | final public static int ARGUMENT_DISALLOWED(Code) | | Flag to say this option does not take arguments
|
ARGUMENT_OPTIONAL | final public static int ARGUMENT_OPTIONAL(Code) | | Flag to say that the argument is optional
|
ARGUMENT_REQUIRED | final public static int ARGUMENT_REQUIRED(Code) | | Flag to say that one argument is required
|
DUPLICATES_ALLOWED | final public static int DUPLICATES_ALLOWED(Code) | | Flag to say this option may be repeated on the command line
|
CLOptionDescriptor | public CLOptionDescriptor(String name, int flags, int id, String description)(Code) | | Constructor.
Parameters: name - the name/long option Parameters: flags - the flags Parameters: id - the id/character option Parameters: description - description of option usage |
CLOptionDescriptor | public CLOptionDescriptor(String name, int flags, int id, String description, CLOptionDescriptor[] incompatible)(Code) | | Constructor.
Parameters: name - the name/long option Parameters: flags - the flags Parameters: id - the id/character option Parameters: description - description of option usage Parameters: incompatible - descriptors for incompatible options |
getDescription | final public String getDescription()(Code) | | Retrieve textual description.
the description |
getFlags | final public int getFlags()(Code) | | Retrieve flags about option. Flags include details such as whether it
allows parameters etc.
the flags |
getId | final public int getId()(Code) | | Retrieve the id for option. The id is also the character if using single
character options.
the id |
getIncompatible | final protected int[] getIncompatible()(Code) | | Get the array of incompatible option ids.
the array of incompatible option ids |
getName | final public String getName()(Code) | | Retrieve name of option which is also text for long option.
name/long option |
toString | final public String toString()(Code) | | Convert to String.
the converted value to string. |
|
|