[CLI-266] HelpFormatter#setOptionComparator(null) doesn't display the values in inserted order

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.3.1
• Fix Version/s: 1.4
• Component/s: CLI-1.x, Help formatter
• Labels: easyfix

Environment

Windows

• Assignee: Benedikt Ritter
• Reporter: Raviteja Lokineni
• Created: 09/Jun/16 19:21
• Updated: 13/Mar/17 14:12
• Resolved: 21/Jun/16 20:27

Description

OptionGroup group = new OptionGroup();
Option h = Option.builder("h").build();
Option s = Option.builder("s").build();
Option b = Option.builder("b").build();
Option t = Option.builder("t").build();
group.addOption(h)
    .addOption(s)
    .addOption(b)
    .addOption(t);
Options options = new Options();
options.addOptionGroup(group);
options.addOption(Option.builder("o").build());
HelpFormatter formatter = new HelpFormatter();
formatter.setOptionComparator(null);
formatter.printHelp("cmd", "", options, null);

This code does print the options(1. Group, 2. Option "o") in the order of insertion but the groups order of display is messed up.

The OptionGroup internally uses a HashMap. If that could be replaced with a LinkedHashMap this issue can be solved.

Issue Links

• links to: GitHub Pull Request #6