net.dpml.cli
Interface HelpLine

All Known Implementing Classes:
HelpLineImpl

public interface HelpLine

Represents a line of help for a particular Option.

Version:
@PROJECT-VERSION@
Author:
@PUBLISHER-NAME@

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

Method Detail

getDescription

java.lang.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

java.lang.String usage(java.util.Set helpSettings,
                       java.util.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