添加链接
link管理
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接
expectedOpts
The required options and groups expected to be found when parsing the command line.
protected Options
The current options.
protected boolean
Flag indicating if tokens should no longer be analyzed and simply added as arguments of the command line.
protected boolean
Flag indicating how unrecognized tokens are handled.
Creates a new DefaultParser instance with partial matching enabled.
DefaultParser (boolean allowPartialMatching)
Create a new DefaultParser instance with the specified partial matching policy.
Creates a new DefaultParser.Builder to create an DefaultParser using descriptive methods.
protected void
Throws a MissingOptionException if all of the required options are not present.
protected void
Breaks token into its constituent parts using the following algorithm.
parse ( Options options, String [] arguments)
Parses the arguments according to the specified options.
parse ( Options options, String [] arguments, boolean stopAtNonOption)
Parses the arguments according to the specified options.
parse ( Options options, String [] arguments, Properties properties)
Parses the arguments according to the specified options and properties.
parse ( Options options, String [] arguments, Properties properties, boolean stopAtNonOption)
Parses the arguments according to the specified options and properties.

stopAtNonOption

protected boolean stopAtNonOption
Flag indicating how unrecognized tokens are handled. true to stop the parsing and add the remaining tokens to the args list. false to throw an exception.

DefaultParser

public DefaultParser ()
Creates a new DefaultParser instance with partial matching enabled. By "partial matching" we mean that given the following code: @code final Options options = new Options(); options.addOption(new Option("d", "debug", false, "Turn on debug.")); options.addOption(new Option("e", "extract", false, "Turn on extract.")); options.addOption(new Option("o", "option", true, "Turn on option with argument.")); with "partial matching" turned on, -de only matches the "debug" option. However, with "partial matching" disabled, -de would enable both debug as well as extract options.

DefaultParser

public DefaultParser (boolean allowPartialMatching)
Create a new DefaultParser instance with the specified partial matching policy. By "partial matching" we mean that given the following code: @code final Options options = new Options(); options.addOption(new Option("d", "debug", false, "Turn on debug.")); options.addOption(new Option("e", "extract", false, "Turn on extract.")); options.addOption(new Option("o", "option", true, "Turn on option with argument.")); with "partial matching" turned on, -de only matches the "debug" option. However, with "partial matching" disabled, -de would enable both debug as well as extract options.
Parameters:
allowPartialMatching - if partial matching of long options shall be enabled

builder

Creates a new DefaultParser.Builder to create an DefaultParser using descriptive methods.
Returns:
a new DefaultParser.Builder instance
Since:
1.5.0

checkRequiredOptions

Throws a MissingOptionException if all of the required options are not present.
Throws:
MissingOptionException - if any of the required Options are not present.

handleConcatenatedOptions

Breaks token into its constituent parts using the following algorithm.
  • ignore the first character (" - ")
  • for each remaining character check if an Option exists with that id.
  • if an Option does exist then add that character prepended with " - " to the list of processed tokens.
  • if the Option can have an argument value and there are remaining characters in the token then add the remaining characters as a token to the list of processed tokens.
  • if an Option does NOT exist AND stopAtNonOption IS set then add the special token " -- " followed by the remaining characters and also the remaining tokens directly to the processed tokens list.
  • if an Option does NOT exist AND stopAtNonOption IS NOT set then add that character prepended with " - ".
  • Parameters:
    token - The current token to be burst at the first non-Option encountered.
    Throws:
    ParseException - if there are any problems encountered while parsing the command line token.
    public CommandLine parse ( Options options, String [] arguments) throws ParseException
    Description copied from interface: CommandLineParser
    Parses the arguments according to the specified options.
    Specified by:
    parse in interface CommandLineParser
    Parameters:
    options - the specified Options
    arguments - the command line arguments
    Returns:
    the list of atomic option and value tokens
    Throws:
    ParseException - if there are any problems encountered while parsing the command line tokens.
    public CommandLine parse ( Options options, String [] arguments, boolean stopAtNonOption) throws ParseException
    Description copied from interface: CommandLineParser
    Parses the arguments according to the specified options.
    Specified by:
    parse in interface CommandLineParser
    Parameters:
    options - the specified Options
    arguments - the command line arguments
    stopAtNonOption - if true an unrecognized argument stops the parsing and the remaining arguments are added to the CommandLine s args list. If false an unrecognized argument triggers a ParseException.
    Returns:
    the list of atomic option and value tokens
    Throws:
    ParseException - if there are any problems encountered while parsing the command line tokens.
    public CommandLine parse ( Options options, String [] arguments, Properties properties) throws ParseException
    Parses the arguments according to the specified options and properties.
    Parameters:
    options - the specified Options
    arguments - the command line arguments
    properties - command line option name-value pairs
    Returns:
    the list of atomic option and value tokens
    Throws:
    ParseException - if there are any problems encountered while parsing the command line tokens.
    public CommandLine parse ( Options options, String [] arguments, Properties properties, boolean stopAtNonOption) throws ParseException
    Parses the arguments according to the specified options and properties.
    Parameters:
    options - the specified Options
    arguments - the command line arguments
    properties - command line option name-value pairs
    stopAtNonOption - if true an unrecognized argument stops the parsing and the remaining arguments are added to the CommandLine s args list. If false an unrecognized argument triggers a ParseException.
    Returns:
    the list of atomic option and value tokens
    Throws:
    ParseException - if there are any problems encountered while parsing the command line tokens.