Package nz.org.riskscape.picocli

Interface CommandLine.Model.IOrdered

All Known Implementing Classes:
CommandLine.Model.ArgGroupSpec, CommandLine.Model.OptionSpec
Enclosing class:
CommandLine.Model
public static interface CommandLine.Model.IOrdered
Interface for sorting options and groups together.
Since:
4.0

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    order()
    Returns the position in the options list in the usage help message at which this element should be shown.

  • Method Details

    • order

      int order()
      Returns the position in the options list in the usage help message at which this element should be shown. Elements with a lower number are shown before elements with a higher number. For options, this attribute is only honored if CommandLine.Model.UsageMessageSpec.sortOptions() is false for this command. For argument groups, this attribute is only honored for groups that have a heading (or a headingKey with a non-null value).