Module net.sourceforge.argparse4j
Package net.sourceforge.argparse4j.internal

Class SubparsersImpl

java.lang.Object
net.sourceforge.argparse4j.internal.SubparsersImpl
All Implemented Interfaces:
Subparsers
public final class SubparsersImpl extends Object implements Subparsers
The application code must not use this class directly.

  • Field Details

    • mainParser_

      private final ArgumentParserImpl mainParser_

    • parsers_

      private final Map<String,SubparserImpl> parsers_
      The key is subparser command or alias name and value is subparser object. The real command and alias names share the same subparser object. To identify the aliases, check key equals to SubparserImpl.getCommand(). If they are equal, it is not alias.

    • help_

      private String help_

    • title_

      private String title_

    • description_

      private String description_

    • dest_

      private String dest_

    • metavar_

      private String metavar_

  • Constructor Details

  • Method Details

    • addParser

      public SubparserImpl addParser(String command)
      Description copied from interface: Subparsers

      Adds and returns Subparser object with given sub-command name. The given command must be unique for each Subparsers instance.

      The prefixChars is inherited from main ArgumentParser.

      Specified by:
      addParser in interface Subparsers
      Parameters:
      command - Sub-command name
      Returns:
      Subparser object.

    • addParser

      public SubparserImpl addParser(String command, boolean addHelp)
      Description copied from interface: Subparsers

      Adds and returns Subparser object with given sub-command name and addHelp. The given command must be unique for each Subparsers instance.

      For addHelp, see ArgumentParsers.newArgumentParser(String, boolean, String). The prefixChars is inherited from main ArgumentParser.

      Specified by:
      addParser in interface Subparsers
      Parameters:
      command - Sub-command name
      addHelp - If true, -h/--help are available. If false, they are not.
      Returns:
      Subparser object

    • addParser

      public SubparserImpl addParser(String command, boolean addHelp, String prefixChars)
      Description copied from interface: Subparsers

      Adds and returns Subparser object with given sub-command name, addHelp and prefixChars. The given command must be unique for each Subparsers instance.

      For addHelp, see ArgumentParsers.newArgumentParser(String, boolean, String).

      Specified by:
      addParser in interface Subparsers
      Parameters:
      command - Sub-command name
      addHelp - If true, -h/--help are available. If false, they are not.
      prefixChars - The set of characters that prefix named arguments.
      Returns:
      Subparser object

    • dest

      public SubparsersImpl dest(String dest)
      Description copied from interface: Subparsers
      Sets the name of attribute which the selected command name is stored.
      Specified by:
      dest in interface Subparsers
      Parameters:
      dest - The name of attribute the selected command name is stored.
      Returns:
      this.

    • help

      public SubparsersImpl help(String help)
      Description copied from interface: Subparsers
      Sets the text to display in the help message for sub-commands.
      Specified by:
      help in interface Subparsers
      Parameters:
      help - The text to display in the help message.
      Returns:
      this

    • title

      public SubparsersImpl title(String title)
      Description copied from interface: Subparsers

      Sets the text to display as a title of sub-commands in the help message.

      If either title or description(Subparsers.description(String)) is specified, sub-command help will be displayed in its own group.

      Specified by:
      title in interface Subparsers
      Parameters:
      title - The text to display as a title of sub-commands
      Returns:
      this

    • getTitle

      public String getTitle()

    • description

      public SubparsersImpl description(String description)
      Description copied from interface: Subparsers

      Sets the text to display to briefly describe sub-commands in the help message.

      If either description or title(Subparsers.title(String)) is specified, sub-command help will be displayed in its own group.

      Specified by:
      description in interface Subparsers
      Parameters:
      description - The text to display to briefly describe sub-commands
      Returns:
      this

    • getDescription

      public String getDescription()

    • metavar

      public SubparsersImpl metavar(String metavar)
      Description copied from interface: Subparsers

      Sets the text used to represent sub-commands in help messages.

      By default, text to represent sub-commands are concatenation of all sub-commands. This method can override this default behavior and sets arbitrary string to use. This is useful if there are many sub-commands and you don't want to show them all.

      Specified by:
      metavar in interface Subparsers
      Parameters:
      metavar - The text used to represent sub-commands in help messages
      Returns:
      this

    • hasSubCommand

      boolean hasSubCommand()

    • hasNotSuppressedSubCommand

      boolean hasNotSuppressedSubCommand()
      Return true if SubparserImpl has at least one sub-command whose help output is not suppressed.
      Returns:
      true if SubparserImpl has at least one sub-command whose help output is not suppressed.

    • resolveNextSubparser

      private SubparserImpl resolveNextSubparser(String command) throws ArgumentParserException
      Get next SubparserImpl from given command and state. This function resolves abbreviated command input as well. If the given command is ambiguous, ArgumentParserException will be thrown. If no matching SubparserImpl is found, this function returns null.
      Returns:
      next SubparserImpl or null
      Throws:
      ArgumentParserException

    • parseArg

      void parseArg(ParseState state, Map<String,Object> opts) throws ArgumentParserException
      Throws:
      ArgumentParserException

    • formatShortSyntax

      String formatShortSyntax()

    • printSubparserHelp

      void printSubparserHelp(PrintWriter writer, int format_width)
      Writes the help message for this and descendants.
      Parameters:
      writer - The writer to output
      format_width - column width

    • getCommands

      Collection<String> getCommands()
      Returns collection of the sub-command name under this object.
      Returns:
      collection of the sub-command name

    • addAlias

      void addAlias(SubparserImpl subparser, String... alias)
      Adds Subparser alias names for given Subparser. For each SubparsersImpl instance, alias names and commands must be unique. If duplication is found, IllegalArgumentException is thrown.
      Parameters:
      subparser - Subparser to add alias names
      alias - alias name

    • localize

      private String localize(String messageKey)