ArgHandlerExtra (GWT Javadoc)

java.lang.Object

com.google.gwt.util.tools.ArgHandler

com.google.gwt.util.tools.ArgHandlerExtra

public abstract class ArgHandlerExtra extends ArgHandler

Argument handler that handles arguments that do not have preceding flags.

Constructor Summary

Constructors

Constructor

Description

ArgHandlerExtra()
Method Summary

Modifier and Type

Method

Description

abstract boolean

addExtraArg(String arg)

Processes the given "extra" argument.

final String

getTag()

int

handle(String[] args, int startIndex)

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

boolean

isRequired()

Methods inherited from class com.google.gwt.util.tools.ArgHandler
getDefaultArgs, getHelpTag, getPurpose, getTagArgs, getTags, isExperimental, isUndocumented

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ArgHandlerExtra
  
  public ArgHandlerExtra()
Method Details
- addExtraArg
  
  public abstract boolean addExtraArg(String arg)
  
  Processes the given "extra" argument.
  
  Returns:
  
  false to abort the command and print a usage error.
- getTag
  
  public final String getTag()
  
  Specified by:
  
  getTag in class ArgHandler
- handle
  
  public int handle(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