Skip to content

Javadoc: Test how '!' marks a required option in PatternOptionBuilder #449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garydgregory merged 3 commits into from
Oct 30, 2026
Merged

Javadoc: Test how '!' marks a required option in PatternOptionBuilder #449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ecb53fb
Fix PatternOptionBuilder '!' marking the wrong option as required
oscerd Oct 28, 2026
2ad2c7a
Merge branch 'master' into pattern-required-mark
garydgregory Oct 29, 2026
fb89418
Keep the '!' behavior in PatternOptionBuilder and test it
oscerd Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
*
* <p>
* For example, the following accepts command-line arguments such as {@code -v -p string-value -f https://example.com}. The exclamation mark makes the
* preceding option mandatory.
* preceding option mandatory, here {@code -p}. An exclamation mark at the start of the pattern makes the first option mandatory.
* </p>
*
* <pre>
Expand Down
37 changes: 37 additions & 0 deletions src/test/java/org/apache/commons/cli/PatternOptionBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,35 @@ void testObjectPattern() throws Exception {
assertNull(line.getOptionObject("n"), "n value");
}

@Test
void testRequiredMarkAfterOption() throws Exception {
// The class Javadoc example: '!' makes the preceding option, -p, mandatory.
final Options options = PatternOptionBuilder.parsePattern("vp:!f/");
assertFalse(options.getOption("v").isRequired(), "v");
assertTrue(options.getOption("p").isRequired(), "p");
assertFalse(options.getOption("f").isRequired(), "f");
final MissingOptionException e = assertThrows(MissingOptionException.class,
() -> new DefaultParser().parse(options, new String[] { "-v", "-f", "https://example.com" }));
assertEquals(1, e.getMissingOptions().size());
assertTrue(e.getMissingOptions().contains("p"));
}

@Test
void testRequiredMarkAtEnd() {
final Options options = PatternOptionBuilder.parsePattern("a:b!");
assertFalse(options.getOption("a").isRequired(), "a");
assertTrue(options.getOption("b").isRequired(), "b");
}

@Test
void testRequiredMarkBeforeValueCode() {
// The example from CLI-55: "hc!<" makes -c mandatory.
final Options options = PatternOptionBuilder.parsePattern("hc!<");
assertFalse(options.getOption("h").isRequired(), "h");
assertTrue(options.getOption("c").isRequired(), "c");
assertEquals(PatternOptionBuilder.EXISTING_FILE_VALUE, options.getOption("c").getType());
}

@Test
void testRequiredOption() throws Exception {
final Options options = PatternOptionBuilder.parsePattern("!n%m%");
Expand All @@ -108,6 +137,14 @@ void testRequiredOption() throws Exception {
assertTrue(e.getMissingOptions().contains("n"));
}

@Test
void testRequiredOptions() {
final Options options = PatternOptionBuilder.parsePattern("a!b:!c");
assertTrue(options.getOption("a").isRequired(), "a");
assertTrue(options.getOption("b").isRequired(), "b");
assertFalse(options.getOption("c").isRequired(), "c");
}

@Test
void testSimplePattern() throws Exception {
/*
Expand Down
Loading