public class HelpFormatter
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
private static class |
HelpFormatter.StringBufferComparator |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ARG_NAME |
static int |
DEFAULT_DESC_PAD |
static int |
DEFAULT_LEFT_PAD |
static java.lang.String |
DEFAULT_LONG_OPT_PREFIX |
static java.lang.String |
DEFAULT_OPT_PREFIX |
static java.lang.String |
DEFAULT_SYNTAX_PREFIX |
static int |
DEFAULT_WIDTH |
java.lang.String |
defaultArgName |
int |
defaultDescPad |
int |
defaultLeftPad |
java.lang.String |
defaultLongOptPrefix |
java.lang.String |
defaultNewLine |
java.lang.String |
defaultOptPrefix |
java.lang.String |
defaultSyntaxPrefix |
int |
defaultWidth |
Constructor and Description |
---|
HelpFormatter() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
createPadding(int len) |
protected int |
findWrapPos(java.lang.String text,
int width,
int startPos)
Finds the next text wrap position after
startPos for the text
in sb with the column width width . |
void |
printHelp(int width,
java.lang.String cmdLineSyntax,
java.lang.String header,
Options options,
java.lang.String footer) |
void |
printHelp(int width,
java.lang.String cmdLineSyntax,
java.lang.String header,
Options options,
java.lang.String footer,
boolean autoUsage) |
void |
printHelp(java.io.PrintWriter pw,
int width,
java.lang.String cmdLineSyntax,
java.lang.String header,
Options options,
int leftPad,
int descPad,
java.lang.String footer) |
void |
printHelp(java.io.PrintWriter pw,
int width,
java.lang.String cmdLineSyntax,
java.lang.String header,
Options options,
int leftPad,
int descPad,
java.lang.String footer,
boolean autoUsage) |
void |
printHelp(java.lang.String cmdLineSyntax,
Options options) |
void |
printHelp(java.lang.String cmdLineSyntax,
Options options,
boolean autoUsage) |
void |
printHelp(java.lang.String cmdLineSyntax,
java.lang.String header,
Options options,
java.lang.String footer) |
void |
printHelp(java.lang.String cmdLineSyntax,
java.lang.String header,
Options options,
java.lang.String footer,
boolean autoUsage) |
void |
printOptions(java.io.PrintWriter pw,
int width,
Options options,
int leftPad,
int descPad) |
void |
printUsage(java.io.PrintWriter pw,
int width,
java.lang.String cmdLineSyntax) |
void |
printUsage(java.io.PrintWriter pw,
int width,
java.lang.String app,
Options options)
Prints the usage statement for the specified application.
|
void |
printWrapped(java.io.PrintWriter pw,
int width,
int nextLineTabStop,
java.lang.String text) |
void |
printWrapped(java.io.PrintWriter pw,
int width,
java.lang.String text) |
protected java.lang.StringBuffer |
renderOptions(java.lang.StringBuffer sb,
int width,
Options options,
int leftPad,
int descPad) |
protected java.lang.StringBuffer |
renderWrappedText(java.lang.StringBuffer sb,
int width,
int nextLineTabStop,
java.lang.String text) |
protected java.lang.String |
rtrim(java.lang.String s) |
public static final int DEFAULT_WIDTH
public static final int DEFAULT_LEFT_PAD
public static final int DEFAULT_DESC_PAD
public static final java.lang.String DEFAULT_SYNTAX_PREFIX
public static final java.lang.String DEFAULT_OPT_PREFIX
public static final java.lang.String DEFAULT_LONG_OPT_PREFIX
public static final java.lang.String DEFAULT_ARG_NAME
public int defaultWidth
public int defaultLeftPad
public int defaultDescPad
public java.lang.String defaultSyntaxPrefix
public java.lang.String defaultNewLine
public java.lang.String defaultOptPrefix
public java.lang.String defaultLongOptPrefix
public java.lang.String defaultArgName
public void printHelp(java.lang.String cmdLineSyntax, Options options)
public void printHelp(java.lang.String cmdLineSyntax, Options options, boolean autoUsage)
public void printHelp(java.lang.String cmdLineSyntax, java.lang.String header, Options options, java.lang.String footer)
public void printHelp(java.lang.String cmdLineSyntax, java.lang.String header, Options options, java.lang.String footer, boolean autoUsage)
public void printHelp(int width, java.lang.String cmdLineSyntax, java.lang.String header, Options options, java.lang.String footer)
public void printHelp(int width, java.lang.String cmdLineSyntax, java.lang.String header, Options options, java.lang.String footer, boolean autoUsage)
public void printHelp(java.io.PrintWriter pw, int width, java.lang.String cmdLineSyntax, java.lang.String header, Options options, int leftPad, int descPad, java.lang.String footer) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public void printHelp(java.io.PrintWriter pw, int width, java.lang.String cmdLineSyntax, java.lang.String header, Options options, int leftPad, int descPad, java.lang.String footer, boolean autoUsage) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public void printUsage(java.io.PrintWriter pw, int width, java.lang.String app, Options options)
Prints the usage statement for the specified application.
pw
- The PrintWriter to print the usage statementwidth
- ??appName
- The application nameoptions
- The command line Optionspublic void printUsage(java.io.PrintWriter pw, int width, java.lang.String cmdLineSyntax)
public void printOptions(java.io.PrintWriter pw, int width, Options options, int leftPad, int descPad)
public void printWrapped(java.io.PrintWriter pw, int width, java.lang.String text)
public void printWrapped(java.io.PrintWriter pw, int width, int nextLineTabStop, java.lang.String text)
protected java.lang.StringBuffer renderOptions(java.lang.StringBuffer sb, int width, Options options, int leftPad, int descPad)
protected java.lang.StringBuffer renderWrappedText(java.lang.StringBuffer sb, int width, int nextLineTabStop, java.lang.String text)
protected int findWrapPos(java.lang.String text, int width, int startPos)
startPos
for the text
in sb
with the column width width
.
The wrap point is the last postion before startPos+width having a whitespace
character (space, \n, \r).sb
- text to be analyzedwidth
- width of the wrapped textstartPos
- position from which to start the lookup whitespace characterprotected java.lang.String createPadding(int len)
protected java.lang.String rtrim(java.lang.String s)