org.jboss.axis.utils
Class CLArgsParser

java.lang.Object
  org.jboss.axis.utils.CLArgsParser

public final class CLArgsParser

extends java.lang.Object

Parser for command line arguments.

This parses command lines according to the standard (?) of GNU utilities.

Note: This is still used in 1.1 libraries so do not add 1.2+ dependencies.

Since:

4.0

CLArgsParser

public CLArgsParser(java.lang.String[] args,
                    CLOptionDescriptor (src) [] optionDescriptors,
                    ParserControl (src)  control)

Create a parser that can deal with options and parses certain args.

CLArgsParser

public CLArgsParser(java.lang.String[] args,
                    CLOptionDescriptor (src) [] optionDescriptors)

Create a parser that deals with options and parses certain args.

getUnparsedArgs

public final java.lang.String[] getUnparsedArgs()

getArguments

public final java.util.Vector getArguments()

Retrieve a list of options that were parsed from command list.

Returns:

the list of options

getArgumentById

public final CLOption (src)  getArgumentById(int id)

Retrieve the CLOption (src) with specified id, or null if no command line option is found.

Parameters:

id - the command line option id

Returns:

the CLOption (src) with the specified id, or null if no CLOption is found.

See Also:

CLOption (src)

getArgumentByName

public final CLOption (src)  getArgumentByName(java.lang.String name)

Retrieve the CLOption (src) with specified name, or null if no command line option is found.

Parameters:

name - the command line option name

Returns:

the CLOption (src) with the specified name, or null if no CLOption is found.

See Also:

CLOption (src)

getErrorString

public final java.lang.String getErrorString()

Retrieve an error message that occured during parsing if one existed.

Returns:

the error string