|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjoptsimple.BuiltinHelpFormatter
public class BuiltinHelpFormatter
A help formatter that allows configuration of overall row width and column separator width.
The formatter produces a two-column output. The left column is for the options, and the right column for their descriptions. The formatter will allow as much space as possible for the descriptions, by minimizing the option column's width, no greater than slightly less than half the overall desired width.
Constructor Summary | |
---|---|
BuiltinHelpFormatter(int desiredOverallWidth,
int desiredColumnSeparatorWidth)
Makes a formatter with a given overall row width and column separator width. |
Method Summary | |
---|---|
String |
format(Map<String,? extends OptionDescriptor> options)
Produces help text, given a set of option descriptors. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BuiltinHelpFormatter(int desiredOverallWidth, int desiredColumnSeparatorWidth)
desiredOverallWidth
- how many characters wide to make the overall help displaydesiredColumnSeparatorWidth
- how many characters wide to make the separation between option column and
description columnMethod Detail |
---|
public String format(Map<String,? extends OptionDescriptor> options)
HelpFormatter
format
in interface HelpFormatter
options
- descriptors for the configured options of a parser
OptionParser.printHelpOn(java.io.Writer)
,
OptionParser.formatHelpWith(HelpFormatter)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |