Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

net.dpml.cli

Interface HelpLine

Known Implementing Classes:
HelpLineImpl
public interface HelpLine
Represents a line of help for a particular Option.
Version:
@PROJECT-VERSION@
Author:
@PUBLISHER-NAME@

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 Details

getDescription

public String getDescription()
Returns:
The description of the option

getIndent

public int getIndent()
Returns:
The level of indentation for this line

getOption

public Option getOption()
Returns:
The Option that the help line relates to

usage

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

Overview Package Class Use Source Tree Index Deprecated About