Package io.github.qishr.cascara.common.util

Interface IOrdered

java.lang.Object
        io.github.qishr.cascara.common.util.CommandLine.Model.IOrdered

Enclosing Class:
    io.github.qishr.cascara.common.util.CommandLine.Model

All Known Implementing Classes:
    OptionSpec, ArgGroupSpec

---

public static interface IOrdered

Interface for sorting OptionSpec and ArgGroupSpec together.

Method Summary

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

Method Details

order

public abstract 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 UsageMessageSpec#sortOptions() is false for this command. For argument groups, this attribute is only honored for groups that have a ArgGroup#heading() (or a ArgGroup#headingKey() with a non-null value).

---