|
||||||||||
PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.axis.utils.CLOptionDescriptor
Basic class describing an type of option.
Typically, one creates a static array of CLOptionDescriptor
s,
and passes it to CLArgsParser.CLArgsParser(String[], CLOptionDescriptor[])
.
Field Summary | |
static int |
ARGUMENT_DISALLOWED
Flag to say this option does not take arguments |
static int |
ARGUMENT_OPTIONAL
Flag to say that the argument is optional |
static int |
ARGUMENT_REQUIRED
Flag to say that one argument is required |
static int |
ARGUMENTS_REQUIRED_2
Flag to say this option requires 2 arguments |
static int |
DUPLICATES_ALLOWED
Flag to say this option may be repeated on the command line |
Constructor Summary | |
CLOptionDescriptor(java.lang.String name,
int flags,
int id,
java.lang.String description)
Constructor. |
|
CLOptionDescriptor(java.lang.String name,
int flags,
int id,
java.lang.String description,
int[] incompatable)
Constructor. |
Method Summary | |
java.lang.String |
getDescription()
Retrieve textual description. |
int |
getFlags()
Retrieve flags about option. |
int |
getId()
Retrieve the id for option. |
protected int[] |
getIncompatble()
Deprecated. Use the correctly spelled getIncompatible() instead. |
protected int[] |
getIncompatible()
|
java.lang.String |
getName()
Retrieve name of option which is also text for long option. |
java.lang.String |
toString()
Convert to String. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int ARGUMENT_REQUIRED
public static final int ARGUMENT_OPTIONAL
public static final int ARGUMENT_DISALLOWED
public static final int ARGUMENTS_REQUIRED_2
public static final int DUPLICATES_ALLOWED
Constructor Detail |
public CLOptionDescriptor(java.lang.String name, int flags, int id, java.lang.String description)
name
- the name/long optionflags
- the flagsid
- the id/character optiondescription
- description of option usagepublic CLOptionDescriptor(java.lang.String name, int flags, int id, java.lang.String description, int[] incompatable)
name
- the name/long optionflags
- the flagsid
- the id/character optiondescription
- description of option usageMethod Detail |
protected final int[] getIncompatble()
getIncompatible()
instead.
protected final int[] getIncompatible()
public final java.lang.String getDescription()
public final int getFlags()
public final int getId()
public final java.lang.String getName()
public final java.lang.String toString()
|
||||||||||
PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |