Package org.apache.commons.cli
Class DefaultParser.Builder
- java.lang.Object
-
- org.apache.commons.cli.DefaultParser.Builder
-
- Enclosing class:
- DefaultParser
public static final class DefaultParser.Builder extends java.lang.Object
A nested builder class to createDefaultParser
instances using descriptive methods. Example usage:DefaultParser parser = Option.builder() .setAllowPartialMatching(false) .setStripLeadingAndTrailingQuotes(false) .build();
- Since:
- 1.5.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DefaultParser
build()
Builds an DefaultParser with the values declared by thisDefaultParser.Builder
.DefaultParser.Builder
setAllowPartialMatching(boolean allowPartialMatching)
Sets if partial matching of long options is supported.DefaultParser.Builder
setDeprecatedHandler(java.util.function.Consumer<Option> deprecatedHandler)
Sets the deprecated option handler.DefaultParser.Builder
setStripLeadingAndTrailingQuotes(java.lang.Boolean stripLeadingAndTrailingQuotes)
Sets if balanced leading and trailing double quotes should be stripped from option arguments.
-
-
-
Method Detail
-
build
public DefaultParser build()
Builds an DefaultParser with the values declared by thisDefaultParser.Builder
.- Returns:
- the new
DefaultParser
- Since:
- 1.5.0
-
setAllowPartialMatching
public DefaultParser.Builder setAllowPartialMatching(boolean allowPartialMatching)
Sets if partial matching of long options is supported. 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.")); }
If "partial matching" is turned on,-de
only matches the"debug"
option. However, with "partial matching" disabled,-de
would enable bothdebug
as well asextract
- Parameters:
allowPartialMatching
- whether to allow partial matching of long options- Returns:
- this builder, to allow method chaining
- Since:
- 1.5.0
-
setDeprecatedHandler
public DefaultParser.Builder setDeprecatedHandler(java.util.function.Consumer<Option> deprecatedHandler)
Sets the deprecated option handler.- Parameters:
deprecatedHandler
- the deprecated option handler.- Returns:
this
instance.- Since:
- 1.7.0
-
setStripLeadingAndTrailingQuotes
public DefaultParser.Builder setStripLeadingAndTrailingQuotes(java.lang.Boolean stripLeadingAndTrailingQuotes)
Sets if balanced leading and trailing double quotes should be stripped from option arguments. If "stripping of balanced leading and trailing double quotes from option arguments" is true, the outermost balanced double quotes of option arguments values will be removed. For example,-o '"x"'
getValue() will returnx
, instead of"x"
If "stripping of balanced leading and trailing double quotes from option arguments" is null, then quotes will be stripped from option values separated by space from the option, but kept in other cases, which is the historic behavior.- Parameters:
stripLeadingAndTrailingQuotes
- whether balanced leading and trailing double quotes should be stripped from option arguments.- Returns:
- this builder, to allow method chaining
- Since:
- 1.5.0
-
-