Package org.apache.commons.cli
Class DefaultParser.Builder
java.lang.Object
org.apache.commons.cli.DefaultParser.Builder
- Enclosing class:
- DefaultParser
A nested builder class to create
DefaultParser
instances
using descriptive methods.
Example usage:
DefaultParser parser = Option.builder() .setAllowPartialMatching(false) .setStripLeadingAndTrailingQuotes(false) .build();
- Since:
- 1.5.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Flag indicating if partial matching of long options is supported.private Boolean
Flag indicating if balanced leading and trailing double quotes should be stripped from option arguments. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Builder()
Constructs a newBuilder
for aDefaultParser
instance. -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds an DefaultParser with the values declared by thisDefaultParser.Builder
.setAllowPartialMatching
(boolean allowPartialMatching) Sets if partial matching of long options is supported.setStripLeadingAndTrailingQuotes
(Boolean stripLeadingAndTrailingQuotes) Sets if balanced leading and trailing double quotes should be stripped from option arguments.
-
Field Details
-
allowPartialMatching
private boolean allowPartialMatchingFlag indicating if partial matching of long options is supported. -
stripLeadingAndTrailingQuotes
Flag indicating if balanced leading and trailing double quotes should be stripped from option arguments.
-
-
Constructor Details
-
Builder
private Builder()Constructs a newBuilder
for aDefaultParser
instance. Both allowPartialMatching and stripLeadingAndTrailingQuotes are true by default, mimicking the argument-less constructor.
-
-
Method Details
-
build
Builds an DefaultParser with the values declared by thisDefaultParser.Builder
.- Returns:
- the new
DefaultParser
- Since:
- 1.5.0
-
setAllowPartialMatching
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
-
setStripLeadingAndTrailingQuotes
public DefaultParser.Builder setStripLeadingAndTrailingQuotes(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 behaviour.- 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
-