|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.cli2.option.HelpLineImpl
public class HelpLineImpl
Represents a line in the help screen.
Field Summary | |
---|---|
private java.util.Comparator |
cachedComparator
The comparator used to obtain the previous usage |
private java.util.Set |
cachedHelpSettings
The help settings used to obtain the previous usage |
private java.lang.String |
cachedUsage
The previously obtained usage |
private int |
indent
The level of indenting for this item |
private Option |
option
The option that this HelpLineImpl describes |
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 |
Field Detail |
---|
private final Option option
private final int indent
private transient java.util.Set cachedHelpSettings
private transient java.util.Comparator cachedComparator
private transient java.lang.String cachedUsage
Constructor Detail |
---|
public HelpLineImpl(Option option, int indent)
option
- Option that the HelpLineImpl describesindent
- Level of indentation for this lineMethod Detail |
---|
public java.lang.String getDescription()
getDescription
in interface HelpLine
public int getIndent()
getIndent
in interface HelpLine
public Option getOption()
getOption
in interface HelpLine
public java.lang.String usage(java.util.Set helpSettings, java.util.Comparator comparator)
usage
in interface HelpLine
helpSettings
- the settings to applycomparator
- a comparator to sort options when applicable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |