org.apache.commons.cli.avalon
Class CLOption

java.lang.Object
  org.apache.commons.cli.avalon.CLOption

public final class CLOption
extends Object

Basic class describing an instance of option.

Version:

$Revision: 1.2 $ $Date: 2005/03/18 15:26:55 $

Field Summary

static int

TEXT_ARGUMENT Value of getId() when the option is a text argument.

Constructor Summary

CLOption(CLOptionDescriptor descriptor)
Constructor taking an descriptor

CLOption(String argument)
Constructor taking argument for option.

Method Summary

void	addArgument(String argument) Mutator of Argument property.
String	getArgument() Retrieve argument to option if it takes arguments.
String	getArgument(int index) Retrieve indexed argument to option if it takes arguments.
int	getArgumentCount() Get number of arguments.
CLOptionDescriptor	getDescriptor() DOCUMENT ME!
int	getId() Deprecated. use getDescriptor().getId() instead
String	toString() Convert to String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TEXT_ARGUMENT

public static final int TEXT_ARGUMENT

Value of getId() when the option is a text argument.

See Also:

Constant Field Values

Constructor Detail

CLOption

public CLOption(CLOptionDescriptor descriptor)

Constructor taking an descriptor

Parameters:

descriptor - the descriptor iff null, will default to a "text argument" descriptor.

CLOption

public CLOption(String argument)

Constructor taking argument for option.

Parameters:

argument - the argument

Method Detail

getArgument

public final String getArgument()

Retrieve argument to option if it takes arguments.

Returns:

the (first) argument

getArgument

public final String getArgument(int index)

Retrieve indexed argument to option if it takes arguments.

Parameters:

index - The argument index, from 0 to getArgumentCount()-1.

Returns:

the argument

getId

public final int getId()

Deprecated. use getDescriptor().getId() instead

Retrieve id of option. The id is eqivalent to character code if it can be a single letter option.

Returns:

the id

getDescriptor

public final CLOptionDescriptor getDescriptor()

DOCUMENT ME!

Returns:

DOCUMENT ME!

addArgument

public final void addArgument(String argument)

Mutator of Argument property.

Parameters:

argument - the argument

getArgumentCount

public final int getArgumentCount()

Get number of arguments.

Returns:

the number of arguments

toString

public final String toString()

Convert to String.

Overrides:

toString in class Object

Returns:

the string value