org.apache.axis.utils

Class CLOption


public final class CLOption
extends java.lang.Object

Basic class describing an instance of option.
Author:
Peter Donald
Since:
4.0

Field Summary

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

Constructor Summary

CLOption(String argument)
Constructor taking argument for option.
CLOption(int id)
Constructor taking an id (that must be a proper character code)

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.
int
getId()
Retrieve id of option.
String
toString()
Convert to String.

Field Details

TEXT_ARGUMENT

public static final int TEXT_ARGUMENT
Value of getId() when the option is a text argument.
Field Value:
0

Constructor Details

CLOption

public CLOption(String argument)
Constructor taking argument for option.
Parameters:
argument - the argument

CLOption

public CLOption(int id)
Constructor taking an id (that must be a proper character code)
Parameters:
id - the new id

Method Details

addArgument

public final void addArgument(String argument)
Mutator of Argument property.
Parameters:
argument - the argument

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.
Returns:
the argument

getArgumentCount

public final int getArgumentCount()
Get number of arguments.

getId

public final int getId()
Retrieve id of option. The id is eqivalent to character code if it can be a single letter option.
Returns:
the id

toString

public final String toString()
Convert to String.
Returns:
the string value

Copyright © 2005 Apache Web Services Project. All Rights Reserved.