Interface Subparser

    • Method Detail

      • description

        Subparser description​(java.lang.String description)
        Description copied from interface: ArgumentParser
        Sets the text to display before the argument help.
        Specified by:
        description in interface ArgumentParser
        Parameters:
        description - The text to display before the argument help.
        Returns:
        this
      • epilog

        Subparser epilog​(java.lang.String epilog)
        Description copied from interface: ArgumentParser
        Sets the text to display after the argument help.
        Specified by:
        epilog in interface ArgumentParser
        Parameters:
        epilog - The text to display after the argument help.
        Returns:
        this
      • defaultHelp

        Subparser defaultHelp​(boolean defaultHelp)
        Description copied from interface: ArgumentParser

        If defaultHelp is true, the default values of arguments are printed in help message.

        By default, the default values are not printed in help message.

        Specified by:
        defaultHelp in interface ArgumentParser
        Parameters:
        defaultHelp - Switch to display the default value in help message.
        Returns:
        this
      • setDefault

        Subparser setDefault​(java.lang.String dest,
                             java.lang.Object value)
        Description copied from interface: ArgumentParser

        Sets parser-level default value of attribute dest.

        The parser-level defaults always override argument-level defaults.

        Specified by:
        setDefault in interface ArgumentParser
        Parameters:
        dest - The attribute name.
        value - The default value.
        Returns:
        this
      • setDefaults

        Subparser setDefaults​(java.util.Map<java.lang.String,​java.lang.Object> attrs)
        Description copied from interface: ArgumentParser

        Sets parser-level default values from attrs.

        All key-value pair in attrs are registered to parser-level defaults. The parser-level defaults always override argument-level defaults.

        Specified by:
        setDefaults in interface ArgumentParser
        Parameters:
        attrs - The parser-level default values to add.
        Returns:
        this
      • help

        Subparser help​(java.lang.String help)
        Sets the text to display in help message.
        Parameters:
        help - The text to display in help message.
        Returns:
        this
      • aliases

        Subparser aliases​(java.lang.String... alias)
        Sets alias names for this Subparser. The alias names must be unique for each Subparsers instance which this object belongs to.
        Parameters:
        alias - Alias name for this Subparser.
        Returns:
        this