net.dpml.cli
Interface HelpLine
- All Known Implementing Classes:
- HelpLineImpl
public interface HelpLine
Represents a line of help for a particular Option.
- Version:
- 1.0.0
- Author:
- Digital Product Meta Library
getDescription
String getDescription()
- Returns:
- The description of the option
getIndent
int getIndent()
- Returns:
- The level of indentation for this line
getOption
Option getOption()
- Returns:
- The Option that the help line relates to
usage
String usage(Set helpSettings,
Comparator comparator)
- Builds a usage string for the option using the specified settings and
comparator.
- Parameters:
helpSettings
- the settings to applycomparator
- a comparator to sort options when applicable
- Returns:
- the usage string