Constructor Detail

• ArgHandlerNoopDeprecatedFlag

  public ArgHandlerNoopDeprecatedFlag(int numberOfArgumentsToConsume,
                              java.lang.String... tags)

• ArgHandlerNoopDeprecatedFlag

  public ArgHandlerNoopDeprecatedFlag(java.lang.String... tags)

Method Detail

• isUndocumented

  public boolean isUndocumented()

  Overrides:

  isUndocumented in class ArgHandler

• getPurpose

  public java.lang.String getPurpose()

  Specified by:

  getPurpose in class ArgHandler

• getTag

  public java.lang.String getTag()

  Specified by:

  getTag in class ArgHandler

• 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.

• getWarningMessage

  protected java.lang.String getWarningMessage(java.lang.String tag)