Constructor Detail

• Command

  public Command(String preferredName,
         String description,
         Set aliases,
         boolean required,
         Argument argument,
         Group children,
         int id)

  Creates a new Command instance.

  Parameters:

  preferredName - The name normally used to refer to the Command

  description - A description of the Command

  aliases - Alternative names for the Command

  required - Whether the Command is required

  argument - An Argument that the command takes

  children - The Group of child options for this Command

  id - A unique id for the Command

  See Also:

  ParentImpl.ParentImpl(Argument, Group, String, int, boolean)

Method Detail

• processParent

  public void processParent(WriteableCommandLine commandLine,
                   ListIterator arguments)
                     throws OptionException

  Description copied from interface: Parent
  Processes the parent part of the Option. The combination of parent, argument and children is handled by the process method.

  Parameters:

  commandLine - the CommandLine to write results to

  arguments - a ListIterator over argument strings positioned at the next argument to process

  Throws:

  OptionException - if an error occurs while processing

  See Also:

  Option.process(WriteableCommandLine, ListIterator)

• getTriggers

  public Set getTriggers()

  Description copied from interface: Option
  Identifies the argument prefixes that should trigger this option. This is used to decide which of many Options should be tried when processing a given argument string. The returned Set must not be null.

  Returns:

  The set of triggers for this Option

• validate

  public void validate(WriteableCommandLine commandLine)
                throws OptionException

  Description copied from interface: Option
  Checks that the supplied CommandLine is valid with respect to this option.

  Specified by:

  validate in interface Option

  Overrides:

  validate in class ParentImpl

  Parameters:

  commandLine - The CommandLine to check.

  Throws:

  OptionException - if the CommandLine is not valid.

• appendUsage

  public void appendUsage(StringBuffer buffer,
                 Set helpSettings,
                 Comparator comp)

  Description copied from interface: Option
  Appends usage information to the specified StringBuffer

  Specified by:

  appendUsage in interface Option

  Overrides:

  appendUsage in class ParentImpl

  Parameters:

  buffer - the buffer to append to

  helpSettings - a set of display settings @see DisplaySetting

  comp - a comparator used to sort the Options

• getPreferredName

  public String getPreferredName()

  Description copied from interface: Option
  The preferred name of an option is used for generating help and usage information.

  Returns:

  The preferred name of the option