This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/master by this push:
new ea9e4088 Better parameter names
ea9e4088 is described below
commit ea9e408813e0cdf10d3e35fadfe4de19da74f4b0
Author: Gary D. Gregory <[email protected]>
AuthorDate: Wed Jul 30 08:36:24 2025 -0400
Better parameter names
Better local variable names
---
.../commons/cli/AlreadySelectedException.java | 16 +++---
.../java/org/apache/commons/cli/DefaultParser.java | 16 +++---
.../java/org/apache/commons/cli/HelpFormatter.java | 10 ++--
src/main/java/org/apache/commons/cli/Options.java | 18 +++----
src/main/java/org/apache/commons/cli/Parser.java | 16 +++---
.../commons/cli/help/AbstractHelpFormatter.java | 10 ++--
.../apache/commons/cli/AbstractParserTestCase.java | 52 +++++++++----------
.../commons/cli/AlreadySelectedExceptionTest.java | 8 +--
.../org/apache/commons/cli/HelpFormatterTest.java | 22 ++++----
.../org/apache/commons/cli/OptionGroupTest.java | 60 +++++++++++-----------
.../java/org/apache/commons/cli/OptionsTest.java | 58 ++++++++++-----------
.../org/apache/commons/cli/bug/BugCLI266Test.java | 22 ++++----
.../java/org/apache/commons/cli/bug/BugsTest.java | 8 +--
.../apache/commons/cli/help/HelpFormatterTest.java | 8 +--
14 files changed, 162 insertions(+), 162 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
index 2e94a78e..ec8fdfcc 100644
--- a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
+++ b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
@@ -28,7 +28,7 @@ public class AlreadySelectedException extends ParseException {
private static final long serialVersionUID = 3674381532418544760L;
/** The option group selected. */
- private final OptionGroup group;
+ private final OptionGroup optionGroup;
/** The option that triggered the exception. */
private final Option option;
@@ -36,13 +36,13 @@ public class AlreadySelectedException extends
ParseException {
/**
* Constructs a new {@code AlreadySelectedException} for the specified
option group.
*
- * @param group the option group already selected
+ * @param optionGroup the option group already selected
* @param option the option that triggered the exception
* @since 1.2
*/
- public AlreadySelectedException(final OptionGroup group, final Option
option) {
- this(String.format("The option '%s' was specified but an option from
this group has already been selected: '%s'", option.getKey(),
group.getSelected()),
- group, option);
+ public AlreadySelectedException(final OptionGroup optionGroup, final
Option option) {
+ this(String.format("The option '%s' was specified but an option from
this group has already been selected: '%s'", option.getKey(),
+ optionGroup.getSelected()), optionGroup, option);
}
/**
@@ -54,9 +54,9 @@ public class AlreadySelectedException extends ParseException {
this(message, null, null);
}
- private AlreadySelectedException(final String message, final OptionGroup
group, final Option option) {
+ private AlreadySelectedException(final String message, final OptionGroup
optionGroup, final Option option) {
super(message);
- this.group = group;
+ this.optionGroup = optionGroup;
this.option = option;
}
@@ -77,6 +77,6 @@ public class AlreadySelectedException extends ParseException {
* @since 1.2
*/
public OptionGroup getOptionGroup() {
- return group;
+ return optionGroup;
}
}
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java
b/src/main/java/org/apache/commons/cli/DefaultParser.java
index e0d77fb1..63441666 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -509,8 +509,8 @@ public class DefaultParser implements CommandLineParser {
throw new UnrecognizedOptionException("Default option wasn't
defined", option);
}
// if the option is part of a group, check if another option of
the group has been selected
- final OptionGroup group = options.getOptionGroup(opt);
- final boolean selected = group != null && group.isSelected();
+ final OptionGroup optionGroup = options.getOptionGroup(opt);
+ final boolean selected = optionGroup != null &&
optionGroup.isSelected();
if (!cmd.hasOption(option) && !selected) {
// get the value from the properties
final String value = properties.getProperty(option);
@@ -754,8 +754,8 @@ public class DefaultParser implements CommandLineParser {
currentOption = null;
expectedOpts = new ArrayList<>(options.getRequiredOptions());
// clear the data from the groups
- for (final OptionGroup group : options.getOptionGroups()) {
- group.setSelected(null);
+ for (final OptionGroup optionGroup : options.getOptionGroups()) {
+ optionGroup.setSelected(null);
}
cmd =
CommandLine.builder().setDeprecatedHandler(deprecatedHandler).get();
if (arguments != null) {
@@ -854,11 +854,11 @@ public class DefaultParser implements CommandLineParser {
}
// if the option is in an OptionGroup make that option the selected
option of the group
if (options.getOptionGroup(option) != null) {
- final OptionGroup group = options.getOptionGroup(option);
- if (group.isRequired()) {
- expectedOpts.remove(group);
+ final OptionGroup optionGroup = options.getOptionGroup(option);
+ if (optionGroup.isRequired()) {
+ expectedOpts.remove(optionGroup);
}
- group.setSelected(option);
+ optionGroup.setSelected(option);
}
}
}
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index af57e6e6..7046a023 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -378,14 +378,14 @@ public class HelpFormatter {
* is required. The display of the options is handled by appendOption
*
* @param buff the StringBuilder to append to
- * @param group the group to append
+ * @param optionGroup the group to append
* @see #appendOption(StringBuilder,Option,boolean)
*/
- private void appendOptionGroup(final StringBuilder buff, final OptionGroup
group) {
- if (!group.isRequired()) {
+ private void appendOptionGroup(final StringBuilder buff, final OptionGroup
optionGroup) {
+ if (!optionGroup.isRequired()) {
buff.append("[");
}
- final List<Option> optList = new ArrayList<>(group.getOptions());
+ final List<Option> optList = new ArrayList<>(optionGroup.getOptions());
if (getOptionComparator() != null) {
Collections.sort(optList, getOptionComparator());
}
@@ -398,7 +398,7 @@ public class HelpFormatter {
buff.append(" | ");
}
}
- if (!group.isRequired()) {
+ if (!optionGroup.isRequired()) {
buff.append("]");
}
}
diff --git a/src/main/java/org/apache/commons/cli/Options.java
b/src/main/java/org/apache/commons/cli/Options.java
index ec067690..eb03aaed 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -143,14 +143,14 @@ public class Options implements Serializable {
* the given group are set to optional.
* </p>
*
- * @param group the OptionGroup that is to be added.
+ * @param optionGroup the OptionGroup that is to be added.
* @return the resulting Options instance.
*/
- public Options addOptionGroup(final OptionGroup group) {
- if (group.isRequired()) {
- requiredOpts.add(group);
+ public Options addOptionGroup(final OptionGroup optionGroup) {
+ if (optionGroup.isRequired()) {
+ requiredOpts.add(optionGroup);
}
- for (final Option option : group.getOptions()) {
+ for (final Option option : optionGroup.getOptions()) {
// an Option cannot be required if it is in an
// OptionGroup, either the group is required or
// nothing is required
@@ -158,7 +158,7 @@ public class Options implements Serializable {
final String key = option.getKey();
requiredOpts.remove(key);
addOption(option);
- optionGroups.put(key, group);
+ optionGroups.put(key, optionGroup);
}
return this;
}
@@ -249,11 +249,11 @@ public class Options implements Serializable {
/**
* Gets the OptionGroup the {@code opt} belongs to.
*
- * @param opt the option whose OptionGroup is being queried.
+ * @param option the option whose OptionGroup is being queried.
* @return the OptionGroup if {@code opt} is part of an OptionGroup,
otherwise return null.
*/
- public OptionGroup getOptionGroup(final Option opt) {
- return optionGroups.get(opt.getKey());
+ public OptionGroup getOptionGroup(final Option option) {
+ return optionGroups.get(option.getKey());
}
/**
diff --git a/src/main/java/org/apache/commons/cli/Parser.java
b/src/main/java/org/apache/commons/cli/Parser.java
index b1ff3265..759827f2 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -152,8 +152,8 @@ public abstract class Parser implements CommandLineParser {
opt.clearValues();
}
// clear the data from the groups
- for (final OptionGroup group : options.getOptionGroups()) {
- group.setSelected(null);
+ for (final OptionGroup optionGroup : options.getOptionGroups()) {
+ optionGroup.setSelected(null);
}
// initialize members
setOptions(options);
@@ -280,8 +280,8 @@ public abstract class Parser implements CommandLineParser {
throw new UnrecognizedOptionException("Default option wasn't
defined", option);
}
// if the option is part of a group, check if another option of
the group has been selected
- final OptionGroup group = options.getOptionGroup(opt);
- final boolean selected = group != null && group.isSelected();
+ final OptionGroup optionGroup = options.getOptionGroup(opt);
+ final boolean selected = optionGroup != null &&
optionGroup.isSelected();
if (!cmd.hasOption(option) && !selected) {
// get the value from the properties instance
final String value = properties.getProperty(option);
@@ -328,11 +328,11 @@ public abstract class Parser implements CommandLineParser
{
// if the option is in an OptionGroup make that option the selected
// option of the group
if (getOptions().getOptionGroup(opt) != null) {
- final OptionGroup group = getOptions().getOptionGroup(opt);
- if (group.isRequired()) {
- getRequiredOptions().remove(group);
+ final OptionGroup optionGroup = getOptions().getOptionGroup(opt);
+ if (optionGroup.isRequired()) {
+ getRequiredOptions().remove(optionGroup);
}
- group.setSelected(opt);
+ optionGroup.setSelected(opt);
}
}
diff --git
a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
index fd2fa34b..91f356d5 100644
--- a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
@@ -428,15 +428,15 @@ public abstract class AbstractHelpFormatter {
for (final Option option : optList) {
// get the next Option
// check if the option is part of an OptionGroup
- final OptionGroup group = lookup.apply(option);
+ final OptionGroup optionGroup = lookup.apply(option);
// if the option is part of a group
- if (group != null) {
+ if (optionGroup != null) {
// and if the group has not already been processed
- if (!processedGroups.contains(group)) {
+ if (!processedGroups.contains(optionGroup)) {
// add the group to the processed list
- processedGroups.add(group);
+ processedGroups.add(optionGroup);
// add the usage clause
- buff.append(prefix).append(toSyntaxOptions(group));
+ buff.append(prefix).append(toSyntaxOptions(optionGroup));
prefix = " ";
}
// otherwise the option was displayed in the group previously
so ignore it.
diff --git a/src/test/java/org/apache/commons/cli/AbstractParserTestCase.java
b/src/test/java/org/apache/commons/cli/AbstractParserTestCase.java
index b3e05683..58657821 100644
--- a/src/test/java/org/apache/commons/cli/AbstractParserTestCase.java
+++ b/src/test/java/org/apache/commons/cli/AbstractParserTestCase.java
@@ -260,12 +260,12 @@ public abstract class AbstractParserTestCase {
@Test
void testMissingRequiredGroup() throws Exception {
- final OptionGroup group = new OptionGroup();
- group.addOption(OptionBuilder.create("a"));
- group.addOption(OptionBuilder.create("b"));
- group.setRequired(true);
+ final OptionGroup optionGroup = new OptionGroup();
+ optionGroup.addOption(OptionBuilder.create("a"));
+ optionGroup.addOption(OptionBuilder.create("b"));
+ optionGroup.setRequired(true);
final Options options = new Options();
- options.addOptionGroup(group);
+ options.addOptionGroup(optionGroup);
options.addOption(OptionBuilder.isRequired().create("c"));
final MissingOptionException e =
assertThrows(MissingOptionException.class, () -> parser.parse(options, new
String[] { "-c" }));
assertEquals(1, e.getMissingOptions().size());
@@ -422,34 +422,34 @@ public abstract class AbstractParserTestCase {
@Test
void testOptionGroup() throws Exception {
- final OptionGroup group = new OptionGroup();
- assertFalse(group.isSelected());
- group.addOption(OptionBuilder.create("a"));
- group.addOption(OptionBuilder.create("b"));
+ final OptionGroup optionGroup = new OptionGroup();
+ assertFalse(optionGroup.isSelected());
+ optionGroup.addOption(OptionBuilder.create("a"));
+ optionGroup.addOption(OptionBuilder.create("b"));
final Options options = new Options();
- options.addOptionGroup(group);
+ options.addOptionGroup(optionGroup);
parser.parse(options, new String[] { "-b" });
- assertTrue(group.isSelected());
- assertEquals("b", group.getSelected(), "selected option");
+ assertTrue(optionGroup.isSelected());
+ assertEquals("b", optionGroup.getSelected(), "selected option");
}
@Test
void testOptionGroupLong() throws Exception {
- final OptionGroup group = new OptionGroup();
- group.addOption(OptionBuilder.withLongOpt("foo").create());
- group.addOption(OptionBuilder.withLongOpt("bar").create());
+ final OptionGroup optionGroup = new OptionGroup();
+ optionGroup.addOption(OptionBuilder.withLongOpt("foo").create());
+ optionGroup.addOption(OptionBuilder.withLongOpt("bar").create());
final Options options = new Options();
- options.addOptionGroup(group);
+ options.addOptionGroup(optionGroup);
final CommandLine cl = parser.parse(options, new String[] { "--bar" });
assertTrue(cl.hasOption("bar"));
- assertTrue(group.isSelected());
- assertEquals("bar", group.getSelected(), "selected option");
+ assertTrue(optionGroup.isSelected());
+ assertEquals("bar", optionGroup.getSelected(), "selected option");
}
@Test
@@ -566,15 +566,15 @@ public abstract class AbstractParserTestCase {
void testPropertyOptionGroup() throws Exception {
final Options options = new Options();
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(new Option("a", null));
- group1.addOption(new Option("b", null));
- options.addOptionGroup(group1);
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(new Option("a", null));
+ optionGroup1.addOption(new Option("b", null));
+ options.addOptionGroup(optionGroup1);
- final OptionGroup group2 = new OptionGroup();
- group2.addOption(new Option("x", null));
- group2.addOption(new Option("y", null));
- options.addOptionGroup(group2);
+ final OptionGroup optionGroup2 = new OptionGroup();
+ optionGroup2.addOption(new Option("x", null));
+ optionGroup2.addOption(new Option("y", null));
+ options.addOptionGroup(optionGroup2);
final String[] args = { "-a" };
diff --git
a/src/test/java/org/apache/commons/cli/AlreadySelectedExceptionTest.java
b/src/test/java/org/apache/commons/cli/AlreadySelectedExceptionTest.java
index 03067e90..07ef961b 100644
--- a/src/test/java/org/apache/commons/cli/AlreadySelectedExceptionTest.java
+++ b/src/test/java/org/apache/commons/cli/AlreadySelectedExceptionTest.java
@@ -33,9 +33,9 @@ class AlreadySelectedExceptionTest {
assertEquals("a", new AlreadySelectedException("a").getMessage());
assertNull(new AlreadySelectedException("a").getOption());
final Option option = new Option("a", "d");
- final OptionGroup group = new OptionGroup();
- assertNotNull(new AlreadySelectedException(group,
option).getMessage());
- assertEquals(option, new AlreadySelectedException(group,
option).getOption());
- assertEquals(group, new AlreadySelectedException(group,
option).getOptionGroup());
+ final OptionGroup optionGroup = new OptionGroup();
+ assertNotNull(new AlreadySelectedException(optionGroup,
option).getMessage());
+ assertEquals(option, new AlreadySelectedException(optionGroup,
option).getOption());
+ assertEquals(optionGroup, new AlreadySelectedException(optionGroup,
option).getOptionGroup());
}
}
diff --git a/src/test/java/org/apache/commons/cli/HelpFormatterTest.java
b/src/test/java/org/apache/commons/cli/HelpFormatterTest.java
index d9b59775..9dc30e37 100644
--- a/src/test/java/org/apache/commons/cli/HelpFormatterTest.java
+++ b/src/test/java/org/apache/commons/cli/HelpFormatterTest.java
@@ -528,13 +528,13 @@ class HelpFormatterTest {
@Test
void testPrintOptionGroupUsage() {
- final OptionGroup group = new OptionGroup();
- group.addOption(Option.builder("a").get());
- group.addOption(Option.builder("b").get());
- group.addOption(Option.builder("c").get());
+ final OptionGroup optionGroup = new OptionGroup();
+ optionGroup.addOption(Option.builder("a").get());
+ optionGroup.addOption(Option.builder("b").get());
+ optionGroup.addOption(Option.builder("c").get());
final Options options = new Options();
- options.addOptionGroup(group);
+ options.addOptionGroup(optionGroup);
final StringWriter out = new StringWriter();
@@ -605,14 +605,14 @@ class HelpFormatterTest {
@Test
void testPrintRequiredOptionGroupUsage() {
- final OptionGroup group = new OptionGroup();
- group.addOption(Option.builder("a").get());
- group.addOption(Option.builder("b").get());
- group.addOption(Option.builder("c").get());
- group.setRequired(true);
+ final OptionGroup optionGroup = new OptionGroup();
+ optionGroup.addOption(Option.builder("a").get());
+ optionGroup.addOption(Option.builder("b").get());
+ optionGroup.addOption(Option.builder("c").get());
+ optionGroup.setRequired(true);
final Options options = new Options();
- options.addOptionGroup(group);
+ options.addOptionGroup(optionGroup);
final StringWriter out = new StringWriter();
diff --git a/src/test/java/org/apache/commons/cli/OptionGroupTest.java
b/src/test/java/org/apache/commons/cli/OptionGroupTest.java
index 79653567..56b288b5 100644
--- a/src/test/java/org/apache/commons/cli/OptionGroupTest.java
+++ b/src/test/java/org/apache/commons/cli/OptionGroupTest.java
@@ -38,39 +38,39 @@ class OptionGroupTest {
public void setUp() {
final Option file = new Option("f", "file", false, "file to process");
final Option dir = new Option("d", "directory", false, "directory to
process");
- final OptionGroup group = new OptionGroup();
- group.addOption(file);
- group.addOption(dir);
- options = new Options().addOptionGroup(group);
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(file);
+ optionGroup1.addOption(dir);
+ options = new Options().addOptionGroup(optionGroup1);
final Option section = new Option("s", "section", false, "section to
process");
final Option chapter = new Option("c", "chapter", false, "chapter to
process");
- final OptionGroup group2 = new OptionGroup();
- group2.addOption(section);
- group2.addOption(chapter);
+ final OptionGroup optionGroup2 = new OptionGroup();
+ optionGroup2.addOption(section);
+ optionGroup2.addOption(chapter);
- options.addOptionGroup(group2);
+ options.addOptionGroup(optionGroup2);
final Option importOpt = new Option(null, "import", false, "section to
process");
final Option exportOpt = new Option(null, "export", false, "chapter to
process");
- final OptionGroup group3 = new OptionGroup();
- group3.addOption(importOpt);
- group3.addOption(exportOpt);
- options.addOptionGroup(group3);
+ final OptionGroup optionGroup3 = new OptionGroup();
+ optionGroup3.addOption(importOpt);
+ optionGroup3.addOption(exportOpt);
+ options.addOptionGroup(optionGroup3);
options.addOption("r", "revision", false, "revision number");
}
@Test
void testGetNames() {
- final OptionGroup group = new OptionGroup();
- assertFalse(group.isSelected());
- group.addOption(OptionBuilder.create('a'));
- group.addOption(OptionBuilder.create('b'));
- assertNotNull(group.getNames(), "null names");
- assertEquals(2, group.getNames().size());
- assertTrue(group.getNames().contains("a"));
- assertTrue(group.getNames().contains("b"));
+ final OptionGroup optionGroup = new OptionGroup();
+ assertFalse(optionGroup.isSelected());
+ optionGroup.addOption(OptionBuilder.create('a'));
+ optionGroup.addOption(OptionBuilder.create('b'));
+ assertNotNull(optionGroup.getNames(), "null names");
+ assertEquals(2, optionGroup.getNames().size());
+ assertTrue(optionGroup.getNames().contains("a"));
+ assertTrue(optionGroup.getNames().contains("b"));
}
@Test
@@ -123,17 +123,17 @@ class OptionGroupTest {
@Test
void testToString() {
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(new Option(null, "foo", false, "Foo"));
- group1.addOption(new Option(null, "bar", false, "Bar"));
- if (!"[--bar Bar, --foo Foo]".equals(group1.toString())) {
- assertEquals("[--foo Foo, --bar Bar]", group1.toString());
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(new Option(null, "foo", false, "Foo"));
+ optionGroup1.addOption(new Option(null, "bar", false, "Bar"));
+ if (!"[--bar Bar, --foo Foo]".equals(optionGroup1.toString())) {
+ assertEquals("[--foo Foo, --bar Bar]", optionGroup1.toString());
}
- final OptionGroup group2 = new OptionGroup();
- group2.addOption(new Option("f", "foo", false, "Foo"));
- group2.addOption(new Option("b", "bar", false, "Bar"));
- if (!"[-b Bar, -f Foo]".equals(group2.toString())) {
- assertEquals("[-f Foo, -b Bar]", group2.toString());
+ final OptionGroup optionGroup2 = new OptionGroup();
+ optionGroup2.addOption(new Option("f", "foo", false, "Foo"));
+ optionGroup2.addOption(new Option("b", "bar", false, "Bar"));
+ if (!"[-b Bar, -f Foo]".equals(optionGroup2.toString())) {
+ assertEquals("[-f Foo, -b Bar]", optionGroup2.toString());
}
}
diff --git a/src/test/java/org/apache/commons/cli/OptionsTest.java
b/src/test/java/org/apache/commons/cli/OptionsTest.java
index 9727988e..f0ac9525 100644
--- a/src/test/java/org/apache/commons/cli/OptionsTest.java
+++ b/src/test/java/org/apache/commons/cli/OptionsTest.java
@@ -46,17 +46,17 @@ class OptionsTest {
@Test
void testAddConflictingOptions() {
final Options options1 = new Options();
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(Option.builder("a").get());
- group1.addOption(Option.builder("b").get());
- options1.addOptionGroup(group1);
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(Option.builder("a").get());
+ optionGroup1.addOption(Option.builder("b").get());
+ options1.addOptionGroup(optionGroup1);
options1.addOption(Option.builder("x").get());
options1.addOption(Option.builder("y").get());
final Options options2 = new Options();
- final OptionGroup group2 = new OptionGroup();
- group2.addOption(Option.builder("x").type(Integer.class).get());
- group2.addOption(Option.builder("b").type(Integer.class).get());
- options2.addOptionGroup(group2);
+ final OptionGroup optionGroup2 = new OptionGroup();
+ optionGroup2.addOption(Option.builder("x").type(Integer.class).get());
+ optionGroup2.addOption(Option.builder("b").type(Integer.class).get());
+ options2.addOptionGroup(optionGroup2);
options2.addOption(Option.builder("c").get());
assertThrows(IllegalArgumentException.class, () ->
options1.addOptions(options2));
}
@@ -64,10 +64,10 @@ class OptionsTest {
@Test
void testAddNonConflictingOptions() {
final Options options1 = new Options();
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(Option.builder("a").get());
- group1.addOption(Option.builder("b").get());
- options1.addOptionGroup(group1);
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(Option.builder("a").get());
+ optionGroup1.addOption(Option.builder("b").get());
+ options1.addOptionGroup(optionGroup1);
options1.addOption(Option.builder("x").get());
options1.addOption(Option.builder("y").get());
@@ -83,7 +83,7 @@ class OptionsTest {
underTest.addOptions(options1);
underTest.addOptions(options2);
- final List<OptionGroup> expected = Arrays.asList(group1, group2);
+ final List<OptionGroup> expected = Arrays.asList(optionGroup1, group2);
assertTrue(expected.size() == underTest.getOptionGroups().size() &&
expected.containsAll(underTest.getOptionGroups()));
final Set<Option> expectOpt = new HashSet<>(options1.getOptions());
expectOpt.addAll(options2.getOptions());
@@ -95,11 +95,11 @@ class OptionsTest {
void testAddOptions() {
final Options options = new Options();
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(Option.builder("a").get());
- group1.addOption(Option.builder("b").get());
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(Option.builder("a").get());
+ optionGroup1.addOption(Option.builder("b").get());
- options.addOptionGroup(group1);
+ options.addOptionGroup(optionGroup1);
options.addOption(Option.builder("X").get());
options.addOption(Option.builder("y").get());
@@ -115,11 +115,11 @@ class OptionsTest {
void testAddOptions2X() {
final Options options = new Options();
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(Option.builder("a").get());
- group1.addOption(Option.builder("b").get());
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(Option.builder("a").get());
+ optionGroup1.addOption(Option.builder("b").get());
- options.addOptionGroup(group1);
+ options.addOptionGroup(optionGroup1);
options.addOption(Option.builder("X").get());
options.addOption(Option.builder("y").get());
@@ -186,16 +186,16 @@ class OptionsTest {
void testGetOptionsGroups() {
final Options options = new Options();
- final OptionGroup group1 = new OptionGroup();
- group1.addOption(OptionBuilder.create('a'));
- group1.addOption(OptionBuilder.create('b'));
+ final OptionGroup optionGroup1 = new OptionGroup();
+ optionGroup1.addOption(OptionBuilder.create('a'));
+ optionGroup1.addOption(OptionBuilder.create('b'));
- final OptionGroup group2 = new OptionGroup();
- group2.addOption(OptionBuilder.create('x'));
- group2.addOption(OptionBuilder.create('y'));
+ final OptionGroup optionGroup2 = new OptionGroup();
+ optionGroup2.addOption(OptionBuilder.create('x'));
+ optionGroup2.addOption(OptionBuilder.create('y'));
- options.addOptionGroup(group1);
- options.addOptionGroup(group2);
+ options.addOptionGroup(optionGroup1);
+ options.addOptionGroup(optionGroup2);
assertNotNull(options.getOptionGroups());
assertEquals(2, options.getOptionGroups().size());
diff --git a/src/test/java/org/apache/commons/cli/bug/BugCLI266Test.java
b/src/test/java/org/apache/commons/cli/bug/BugCLI266Test.java
index a02dc374..39cd2fd1 100644
--- a/src/test/java/org/apache/commons/cli/bug/BugCLI266Test.java
+++ b/src/test/java/org/apache/commons/cli/bug/BugCLI266Test.java
@@ -37,32 +37,32 @@ class BugCLI266Test {
private final List<String> sortOrder = Arrays.asList("d", "f", "h", "o",
"p", "s", "t", "w", "x");
private void buildOptionsGroup(final Options options) {
- final OptionGroup firstGroup = new OptionGroup();
- final OptionGroup secondGroup = new OptionGroup();
- firstGroup.setRequired(true);
- secondGroup.setRequired(true);
+ final OptionGroup optionGroup1 = new OptionGroup();
+ final OptionGroup optionGroup2 = new OptionGroup();
+ optionGroup1.setRequired(true);
+ optionGroup2.setRequired(true);
//@formatter:off
- firstGroup.addOption(Option.builder("d")
+ optionGroup1.addOption(Option.builder("d")
.longOpt("db")
.hasArg()
.argName("table-name").get());
- firstGroup.addOption(Option.builder("f")
+ optionGroup1.addOption(Option.builder("f")
.longOpt("flat-file")
.hasArg()
.argName("input.csv").get());
//@formatter:on
- options.addOptionGroup(firstGroup);
+ options.addOptionGroup(optionGroup1);
//@formatter:off
- secondGroup.addOption(Option.builder("x")
+ optionGroup2.addOption(Option.builder("x")
.hasArg()
.argName("arg1").get());
- secondGroup.addOption(Option.builder("s").get());
- secondGroup.addOption(Option.builder("p")
+ optionGroup2.addOption(Option.builder("s").get());
+ optionGroup2.addOption(Option.builder("p")
.hasArg()
.argName("arg1").get());
//@formatter:on
- options.addOptionGroup(secondGroup);
+ options.addOptionGroup(optionGroup2);
}
private Options getOptions() {
diff --git a/src/test/java/org/apache/commons/cli/bug/BugsTest.java
b/src/test/java/org/apache/commons/cli/bug/BugsTest.java
index 68a029ff..0d3aeb7f 100644
--- a/src/test/java/org/apache/commons/cli/bug/BugsTest.java
+++ b/src/test/java/org/apache/commons/cli/bug/BugsTest.java
@@ -160,13 +160,13 @@ class BugsTest {
// Therefore, place them in an option group
String[] argv = {"-exec", "-exec_opt1", "-exec_opt2"};
- final OptionGroup grp = new OptionGroup();
+ final OptionGroup optionGroup = new OptionGroup();
- grp.addOption(new Option("exec", false, "description for this
option"));
+ optionGroup.addOption(new Option("exec", false, "description for this
option"));
- grp.addOption(new Option("rep", false, "description for this option"));
+ optionGroup.addOption(new Option("rep", false, "description for this
option"));
- mainOptions.addOptionGroup(grp);
+ mainOptions.addOptionGroup(optionGroup);
// for the exec option, there are 2 options...
final Options execOptions = new Options();
diff --git a/src/test/java/org/apache/commons/cli/help/HelpFormatterTest.java
b/src/test/java/org/apache/commons/cli/help/HelpFormatterTest.java
index d8453b75..d560a49b 100644
--- a/src/test/java/org/apache/commons/cli/help/HelpFormatterTest.java
+++ b/src/test/java/org/apache/commons/cli/help/HelpFormatterTest.java
@@ -317,7 +317,7 @@ class HelpFormatterTest {
void testToSyntaxOptionGroupTest() {
final HelpFormatter underTest = HelpFormatter.builder().get();
// @formatter:off
- final OptionGroup group = new OptionGroup()
+ final OptionGroup optionGroup = new OptionGroup()
.addOption(Option.builder().option("o").longOpt("one").hasArg().get())
.addOption(Option.builder().option("t").longOpt("two").hasArg().required().argName("other").get())
.addOption(Option.builder().option("th").longOpt("three").required().argName("other").get())
@@ -326,10 +326,10 @@ class HelpFormatterTest {
.addOption(Option.builder().longOpt("six").required().hasArg().argName("other").get())
.addOption(Option.builder().option("s").longOpt("sevem").hasArg().get());
// @formatter:on
- assertEquals("[-f | --five <other> | -o <arg> | -s <arg> | --six
<other> | -t <other> | -th]", underTest.toSyntaxOptions(group));
+ assertEquals("[-f | --five <other> | -o <arg> | -s <arg> | --six
<other> | -t <other> | -th]", underTest.toSyntaxOptions(optionGroup));
- group.setRequired(true);
- assertEquals("-f | --five <other> | -o <arg> | -s <arg> | --six
<other> | -t <other> | -th", underTest.toSyntaxOptions(group));
+ optionGroup.setRequired(true);
+ assertEquals("-f | --five <other> | -o <arg> | -s <arg> | --six
<other> | -t <other> | -th", underTest.toSyntaxOptions(optionGroup));
assertEquals("", underTest.toSyntaxOptions(new OptionGroup()), "empty
group should return empty string");
}
