Class ArgHandlerEnum<T extends Enum<T>>

java.lang.Object
com.google.gwt.util.tools.ArgHandler
com.google.gwt.util.tools.ArgHandlerEnum<T>
Type Parameters:
T - enum type providing option values.

public abstract class ArgHandlerEnum<T extends Enum<T>> extends ArgHandler
A generic arg handler for options defined by enums.
  • Constructor Details

    • ArgHandlerEnum

      public ArgHandlerEnum(Class<T> optionsEnumClass)
      Constructor, default value must be handled by the user code.
    • ArgHandlerEnum

      public ArgHandlerEnum(Class<T> optionsEnumClass, @Nullable T defaultValue, boolean allowAbbreviation)
      Constructor, allows to specify the default value for the option and whether to accept or prefixes as abbreviations.

      When defaultValue is null, handling of the default for the option is left to be handled by the user code.

  • Method Details

    • getDefaultArgs

      public String[] getDefaultArgs()
      Overrides:
      getDefaultArgs in class ArgHandler
    • getTagArgs

      public 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 final 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.
    • getPurposeString

      protected String getPurposeString(String prefix)
    • setValue

      public abstract void setValue(T value)
      Override to handle the setting of an enum value.