Interface ArgumentParser

    • Method Detail

      • addArgumentGroup

        ArgumentGroup addArgumentGroup​(java.lang.String title)

        Creates new ArgumentGroup object and adds to this parser and returns the object.

        The title is printed in help message as a title of this group. ArgumentGroup provides a way to conceptually group up command line arguments.

        Parameters:
        title - The title printed in help message.
        Returns:
        ArgumentGroup object.
      • addMutuallyExclusiveGroup

        MutuallyExclusiveGroup addMutuallyExclusiveGroup​(java.lang.String title)

        Creates new mutually exclusive group, MutuallyExclusiveGroup object, and adds to this parser and returns the object.

        The arguments added to this group are mutually exclusive; if more than one argument belong to the group are specified, an error will be reported. The title is printed in help message as a title of this group.

        Parameters:
        title - The title printed in help message.
        Returns:
        The MutuallyExclusiveGroup object.
      • addSubparsers

        Subparsers addSubparsers()

        Returns Subparsers.

        The method name is rather controversial because repeated call of this method does not add new Subparsers object. Instead, this method always returns same Subparsers object. Subparsers object provides a way to add sub-commands.

        Returns:
        Subparsers object.
      • usage

        ArgumentParser usage​(java.lang.String usage)

        Sets the text to display as usage line. By default, the usage line is calculated from the arguments this object contains.

        If the given usage contains ${prog} string, it will be replaced with the program name given in ArgumentParsers.newArgumentParser(String).

        Parameters:
        usage - usage text
        Returns:
        this
      • description

        ArgumentParser description​(java.lang.String description)
        Description copied from interface: ArgumentContainer
        Sets the description for the arguments of this container.
        Specified by:
        description in interface ArgumentContainer
        Parameters:
        description - The description of this container.
        Returns:
        this
      • epilog

        ArgumentParser epilog​(java.lang.String epilog)
        Sets the text to display after the argument help.
        Parameters:
        epilog - The text to display after the argument help.
        Returns:
        this
      • version

        ArgumentParser version​(java.lang.String version)

        Sets version string. It will be displayed printVersion().

        If the given usage contains ${prog} string, it will be replaced with the program name given in ArgumentParsers.newArgumentParser(String). This processed text will be printed without text-wrapping.

        Parameters:
        version - The version string.
        Returns:
        this
      • defaultHelp

        ArgumentParser defaultHelp​(boolean defaultHelp)

        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.

        Parameters:
        defaultHelp - Switch to display the default value in help message.
        Returns:
        this
      • printHelp

        void printHelp()
        Prints help message in stdout.
      • printHelp

        void printHelp​(java.io.PrintWriter writer)
        Prints help message in writer.
        Parameters:
        writer - Writer to print message.
      • formatHelp

        java.lang.String formatHelp()
        Returns help message.
        Returns:
        The help message.
      • printUsage

        void printUsage()
        Print a brief description of how the program should be invoked on the command line in stdout.
      • printUsage

        void printUsage​(java.io.PrintWriter writer)
        Print a brief description of how the program should be invoked on the command line in writer.
        Parameters:
        writer - Writer to print message.
      • formatUsage

        java.lang.String formatUsage()
        Returns a brief description of how the program should be invoked on the command line.
        Returns:
        Usage text.
      • printVersion

        void printVersion()
        Prints version string in stdout.
      • printVersion

        void printVersion​(java.io.PrintWriter writer)
        Prints version string in writer.
        Parameters:
        writer - Writer to print version string.
      • formatVersion

        java.lang.String formatVersion()
        Returns version string.
        Returns:
        The version string.
      • setDefault

        ArgumentParser setDefault​(java.lang.String dest,
                                  java.lang.Object value)

        Sets parser-level default value of attribute dest.

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

        Parameters:
        dest - The attribute name.
        value - The default value.
        Returns:
        this
      • setDefaults

        ArgumentParser setDefaults​(java.util.Map<java.lang.String,​java.lang.Object> attrs)

        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.

        Parameters:
        attrs - The parser-level default values to add.
        Returns:
        this
      • getDefault

        java.lang.Object getDefault​(java.lang.String dest)

        Returns default value of given dest.

        Returns default value set by Argument.setDefault(Object), setDefault(String, Object) or setDefaults(Map). Please note that while parser-level defaults always override argument-level defaults while parsing, this method examines argument-level defaults first. If no default value is found, then check parser-level defaults. If no default value is found, returns null.

        Parameters:
        dest - The attribute name of default value to get.
        Returns:
        The default value of given dest.
      • parseArgs

        Namespace parseArgs​(java.lang.String[] args)
                     throws ArgumentParserException

        Parses command line arguments.

        The resulted attributes are returned as Namespace object. This method must not alter the status of this parser and can be called multiple times.

        Parameters:
        args - Command line arguments.
        Returns:
        Namespace object.
        Throws:
        ArgumentParserException - If an error occurred.
      • parseArgs

        void parseArgs​(java.lang.String[] args,
                       java.util.Map<java.lang.String,​java.lang.Object> attrs)
                throws ArgumentParserException

        Parses command line arguments.

        Unlike parseArgs(String[]), which returns Namespace object, this method stores attributes in given attrs.

        Parameters:
        args - Command line arguments.
        attrs - Map object to store attributes.
        Throws:
        ArgumentParserException - If an error occurred.
      • parseArgs

        void parseArgs​(java.lang.String[] args,
                       java.lang.Object userData)
                throws ArgumentParserException

        Parses command line arguments.

        Unlike parseArgs(String[]), which returns Namespace object, this method stores attributes in given userData. The location to store value is designated using Arg annotations. User don't have to specify Arg for all attributes: the missing attributes are just skipped. This method performs simple List to generic array conversion. For example, user can assign List<Integer> attribute to generic array int[].

        Parameters:
        args - Command line arguments.
        userData - Object to store attributes.
        Throws:
        ArgumentParserException - If an error occurred.
      • parseArgs

        void parseArgs​(java.lang.String[] args,
                       java.util.Map<java.lang.String,​java.lang.Object> attrs,
                       java.lang.Object userData)
                throws ArgumentParserException

        Parses command line arguments.

        This is a combination of parseArgs(String[], Map) and parseArgs(String[], Object). The all attributes will be stored in attrs. The attributes specified in Arg annotations will be also stored in userData.

        Parameters:
        args - Command line arguments.
        attrs - Map to store attributes.
        userData - Object to store attributes.
        Throws:
        ArgumentParserException - If an error occurred.
      • parseKnownArgsOrFail

        Namespace parseKnownArgsOrFail​(java.lang.String[] args,
                                       java.util.List<java.lang.String> unknown)

        Just like parseArgsOrFail(String[]), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

        Parameters:
        args - Command line arguments.
        unknown - Output variable to store unrecognized arguments, or null
        Returns:
        Namespace object.
        Since:
        0.7.0
      • parseKnownArgs

        Namespace parseKnownArgs​(java.lang.String[] args,
                                 java.util.List<java.lang.String> unknown)
                          throws ArgumentParserException

        Just like parseArgs(String[]), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

        Parameters:
        args - Command line arguments.
        unknown - Output variable to store unrecognized arguments, or null
        Returns:
        Namespace object.
        Throws:
        ArgumentParserException - If an error occurred.
        Since:
        0.7.0
      • parseKnownArgs

        void parseKnownArgs​(java.lang.String[] args,
                            java.util.List<java.lang.String> unknown,
                            java.util.Map<java.lang.String,​java.lang.Object> attrs)
                     throws ArgumentParserException

        Just like parseArgs(String[], Map), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

        Parameters:
        args - Command line arguments.
        unknown - Output variable to store unrecognized arguments, or null
        attrs - Map object to store attributes.
        Throws:
        ArgumentParserException - If an error occurred.
        Since:
        0.7.0
      • parseKnownArgs

        void parseKnownArgs​(java.lang.String[] args,
                            java.util.List<java.lang.String> unknown,
                            java.lang.Object userData)
                     throws ArgumentParserException

        Just like parseArgs(String[], Object), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

        Parameters:
        args - Command line arguments.
        unknown - Output variable to store unrecognized arguments, or null
        userData - Object to store attributes.
        Throws:
        ArgumentParserException - If an error occurred.
        Since:
        0.7.0
      • parseKnownArgs

        void parseKnownArgs​(java.lang.String[] args,
                            java.util.List<java.lang.String> unknown,
                            java.util.Map<java.lang.String,​java.lang.Object> attrs,
                            java.lang.Object userData)
                     throws ArgumentParserException

        Just like parseArgs(String[], Map, Object), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

        Parameters:
        args - Command line arguments.
        unknown - Output variable to store unrecognized arguments, or null
        attrs - Map to store attributes.
        userData - Object to store attributes.
        Throws:
        ArgumentParserException - If an error occurred.
        Since:
        0.7.0
      • handleError

        void handleError​(ArgumentParserException e,
                         java.io.PrintWriter writer)

        Prints usage and error message to the given writer.

        Please note that this method does not terminate the program.

        Parameters:
        e - Error thrown by parseArgs(String[]).
        writer - The writer to which to write error messages
        Since:
        0.8.0
      • getConfig

        ArgumentParserConfiguration getConfig()

        Get the configuration of this argument parser.

        Returns:
        The argument parser configuration.
        Since:
        0.8.0