xapi.args

Class ArgHandler

java.lang.Object

xapi.args.ArgHandler

Direct Known Subclasses:

ArgHandlerDir, ArgHandlerExtra, ArgHandlerFile, ArgHandlerFlag, ArgHandlerInt, ArgHandlerLogLevel, ArgHandlerString

public abstract class ArgHandler
extends Object

Base class for command line argument handlers.

Author:

GWT team "gwtproject.org", James X. Nelson "james@wetheinter.net"

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	EMPTY

Constructor Summary

Constructors

Constructor and Description
ArgHandler()

Method Summary

Modifier and Type	Method and Description
String[]	getDefaultArgs()
abstract String	getPurpose()
abstract String	getTag()
abstract String[]	getTagArgs() A list of words representing the arguments in help text.
abstract int	handle(String[] args, int tagIndex) Attempts to process one flag or "extra" command-line argument (that appears without a flag).
boolean	isRequired()
boolean	isUndocumented()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

protected static final String[] EMPTY

Constructor Detail

ArgHandler

public ArgHandler()

Method Detail

getDefaultArgs

public String[] getDefaultArgs()

getPurpose

public abstract String getPurpose()

getTag

public abstract String getTag()

getTagArgs

public abstract String[] getTagArgs()

A list of words representing the arguments in help text.

handle

public abstract int handle(String[] args,
                           int tagIndex)

Attempts to process one flag or "extra" command-line argument (that appears without a flag).

Parameters:

args - the arguments passed in to main()

tagIndex - an index into args indicating the first argument to use. If this is a handler for a flag argument. Otherwise it's the index of the "extra" argument.

Returns:

the number of additional arguments consumed, not including the flag or extra argument. Alternately, returns -1 if the argument cannot be used. This will causes the program to abort and usage to be displayed.

isRequired

public boolean isRequired()

isUndocumented

public boolean isUndocumented()