org.apache.axis.utils

Class CLOptionDescriptor

public final class CLOptionDescriptor extends Object

Basic class describing an type of option. Typically, one creates a static array of CLOptionDescriptors, and passes it to (String[], CLOptionDescriptor[]).

Since: 4.0

Author: Peter Donald

Field Summary
static intARGUMENTS_REQUIRED_2
Flag to say this option requires 2 arguments
static intARGUMENT_DISALLOWED
Flag to say this option does not take arguments
static intARGUMENT_OPTIONAL
Flag to say that the argument is optional
static intARGUMENT_REQUIRED
Flag to say that one argument is required
static intDUPLICATES_ALLOWED
Flag to say this option may be repeated on the command line
Constructor Summary
CLOptionDescriptor(String name, int flags, int id, String description)
Constructor.
CLOptionDescriptor(String name, int flags, int id, String description, int[] incompatable)
Constructor.
Method Summary
StringgetDescription()
Retrieve textual description.
intgetFlags()
Retrieve flags about option.
intgetId()
Retrieve the id for option.
protected int[]getIncompatble()
protected int[]getIncompatible()
StringgetName()
Retrieve name of option which is also text for long option.
StringtoString()
Convert to String.

Field Detail

ARGUMENTS_REQUIRED_2

public static final int ARGUMENTS_REQUIRED_2
Flag to say this option requires 2 arguments

ARGUMENT_DISALLOWED

public static final int ARGUMENT_DISALLOWED
Flag to say this option does not take arguments

ARGUMENT_OPTIONAL

public static final int ARGUMENT_OPTIONAL
Flag to say that the argument is optional

ARGUMENT_REQUIRED

public static final int ARGUMENT_REQUIRED
Flag to say that one argument is required

DUPLICATES_ALLOWED

public static final int DUPLICATES_ALLOWED
Flag to say this option may be repeated on the command line

Constructor Detail

CLOptionDescriptor

public 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

public CLOptionDescriptor(String name, int flags, int id, String description, int[] incompatable)
Constructor.

Parameters: name the name/long option flags the flags id the id/character option description description of option usage

Method Detail

getDescription

public final String getDescription()
Retrieve textual description.

Returns: the description

getFlags

public final int getFlags()
Retrieve flags about option. Flags include details such as whether it allows parameters etc.

Returns: the flags

getId

public final int getId()
Retrieve the id for option. The id is also the character if using single character options.

Returns: the id

getIncompatble

protected final int[] getIncompatble()

Deprecated: Use the correctly spelled CLOptionDescriptor instead.

getIncompatible

protected final int[] getIncompatible()

getName

public final String getName()
Retrieve name of option which is also text for long option.

Returns: name/long option

toString

public final String toString()
Convert to String.

Returns: the converted value to string.

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.