net.dpml.cli

Interface HelpLine

public interface HelpLine

Represents a line of help for a particular Option.

Version: @PROJECT-VERSION@

Method Summary
String	getDescription()
int	getIndent()
Option	getOption()
String	usage(Set helpSettings, Comparator comparator) Builds a usage string for the option using the specified settings and comparator.

Method Detail

public String getDescription()

Returns: The description of the option

public int getIndent()

Returns: The level of indentation for this line

public Option getOption()

Returns: The Option that the help line relates to

public String usage(Set helpSettings, Comparator comparator)

Builds a usage string for the option using the specified settings and comparator.

Parameters: helpSettings the settings to apply comparator a comparator to sort options when applicable

Returns: the usage string