Apache Commons CLI: ¿pedir opciones de ayuda?

Desde v1.3, puede llamar a setOptionComparator(null), de esta manera el formateador omitirá la ordenación y los argumentos se imprimirán en el mismo orden en que se agregaron.

HelpFormatter formatter = new HelpFormatter();
formatter.setOptionComparator(null);

Enlace al problema real.

A partir de Apache Commons CLI 1.2, puede configurar el comparador directamente en la clase HelpFormatter:

setOptionComparator [aquí]

public void setOptionComparator(Comparator comparator)

Configure el comparador utilizado para ordenar las opciones cuando aparecen en el texto de ayuda. pasando en un null El parámetro establecerá el orden en el modo predeterminado.

Debe proporcionar su propia implementación de Comparator<Option> que clasifica sus opciones en el orden que desee.

Y la mejor forma de KISS para implementar dicho comparador es:

class OptionComparator<T extends Option> implements Comparator<T> {

    private static final String OPTS_ORDER = "abcdef"; // short option names

    public int compare(T o1, T o2) {
        return OPTS_ORDER.indexOf(o1.getOpt()) - OPTS_ORDER.indexOf(o2.getOpt());
    }
}

Actualmente no es compatible. Pero es de código abierto, así que ya sabes qué hacer...

Del código fuente:

    private static class OptionComparator
    implements Comparator {

    /**
     * <p>Compares its two arguments for order. Returns a negative 
     * integer, zero, or a positive integer as the first argument 
     * is less than, equal to, or greater than the second.</p>
     *
     * @param o1 The first Option to be compared.
     * @param o2 The second Option to be compared.
     *
     * @return a negative integer, zero, or a positive integer as 
     * the first argument is less than, equal to, or greater than the 
     * second.
     */
    public int compare(Object o1, Object o2)
    {
        Option opt1 = (Option)o1;
        Option opt2 = (Option)o2;

        return opt1.getKey().compareToIgnoreCase(opt2.getKey());
    }
}

Puede anular el comparador predeterminado y definir el orden que desee.

Si conoce el orden exacto de las opciones, puede extender la clase de opción para incluir su número de orden y proporcionar sus instancias de OrderedOption a la instancia de Opciones usando el método Options.add(Option opt).

Luego, cree un comparador y compare los números de pedido en sus OrderedOptions... Recomendaría no mezclar ambos tipos de instancias de opciones en una instancia de opciones, ya que puede complicar el pedido y también probar la instancia válida de OrderedOption en Comparator.

Puede ordenar los valores de ayuda usando el siguiente código:

    HelpFormatter formatter = new HelpFormatter();
    // print the help options in the save order you added 
    formatter.setOptionComparator(new Comparator<Option>() {
        @Override
        public int compare(Option o1, Option o2) {
            List<Option> options = new ArrayList<Option>(getOptions().getOptions());
            Integer indexOfO1 = options.indexOf(o1);
            Integer indexOfO2 = options.indexOf(o2);
            return indexOfO1.compareTo(indexOfO2);
        }
    });
    formatter.printHelp("Commandline syntax", OPTIONS);