GWT 2.5.0.rc2

com.google.gwt.util.tools
Class ArgHandlerFlag

java.lang.Object
  extended by com.google.gwt.util.tools.ArgHandler
      extended by com.google.gwt.util.tools.ArgHandlerFlag
Direct Known Subclasses:
ArgHandlerIgnore, ArgHandlerOverwrite

public abstract class ArgHandlerFlag
extends ArgHandler

Argument handler for flags that have no parameters.


Constructor Summary
ArgHandlerFlag()
           
 
Method Summary
 java.lang.String[] getTagArgs()
          A list of words representing the arguments in help text.
 int handle(java.lang.String[] args, int startIndex)
          Attempts to process one flag or "extra" command-line argument (that appears without a flag).
 boolean isRequired()
           
abstract  boolean setFlag()
           
 
Methods inherited from class com.google.gwt.util.tools.ArgHandler
getDefaultArgs, getPurpose, getTag, isUndocumented
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ArgHandlerFlag

public ArgHandlerFlag()
Method Detail

getTagArgs

public java.lang.String[] getTagArgs()
Description copied from class: ArgHandler
A list of words representing the arguments in help text.

Specified by:
getTagArgs in class ArgHandler

handle

public int handle(java.lang.String[] args,
                  int startIndex)
Description copied from class: ArgHandler
Attempts to process one flag or "extra" command-line argument (that appears without a flag).

Specified by:
handle in class ArgHandler
Parameters:
args - the arguments passed in to main()
startIndex - 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()
Overrides:
isRequired in class ArgHandler

setFlag

public abstract boolean setFlag()

GWT 2.5.0.rc2