net.dpml.cli.option
Class HelpLineImpl

java.lang.Object
  extended by net.dpml.cli.option.HelpLineImpl
All 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
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

getDescription

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

Specified by:
usage in interface HelpLine
Parameters:
helpSettings - the settings to apply
comparator - a comparator to sort options when applicable
Returns:
the usage string