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.option

Class HelpLineImpl

Implemented Interfaces:
HelpLine
public class HelpLineImpl
extends java.lang.Object
implements HelpLine
Represents a line in the help screen.
Version:
@PROJECT-VERSION@
Author:
@PUBLISHER-NAME@

Constructor Summary

HelpLineImpl(Option option, int indent)
Creates a new HelpLineImpl to represent a particular Option in the online help.

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.

Constructor Details

HelpLineImpl

public HelpLineImpl(Option option,
                    int indent)
Creates a new HelpLineImpl to represent a particular Option in the online help.
Parameters:
option - the Option that the HelpLineImpl describes
indent - the level of indentation for this line

Method Details

getDescription

public String getDescription()
Specified by:
getDescription in interface HelpLine
Returns:
The description of the option

getIndent

public int getIndent()
Specified by:
getIndent in interface HelpLine
Returns:
The level of indentation for this line

getOption

public Option getOption()
Specified by:
getOption in interface HelpLine
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.
Specified by:
usage in interface HelpLine
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