org.apache.commons.cli
public class HelpFormatter extends Object
Nested Class Summary | |
---|---|
static class | HelpFormatter.OptionComparator This class implements the |
Field Summary | |
---|---|
String | defaultArgName
the name of the argument
|
int | defaultDescPad
the number of characters of padding to be prefixed
to each description line
|
int | defaultLeftPad
amount of padding to the left of each line
|
String | defaultLongOptPrefix
the long Opt prefix
|
String | defaultNewLine
the new line string
|
String | defaultOptPrefix
the shortOpt prefix
|
String | defaultSyntaxPrefix
the string to display at the begining of the usage statement
|
int | defaultWidth
number of characters per line
|
static String | DEFAULT_ARG_NAME default name for an argument |
static int | DEFAULT_DESC_PAD
the number of characters of padding to be prefixed
to each description line |
static int | DEFAULT_LEFT_PAD default padding to the left of each line |
static String | DEFAULT_LONG_OPT_PREFIX default prefix for long Option |
static String | DEFAULT_OPT_PREFIX default prefix for shortOpts |
static String | DEFAULT_SYNTAX_PREFIX the string to display at the begining of the usage statement |
static int | DEFAULT_WIDTH default number of characters per line |
Method Summary | |
---|---|
static void | appendOption(StringBuffer buff, Option option, boolean required)
Appends the usage clause for an Option to a StringBuffer.
|
static void | appendOptionGroup(StringBuffer buff, OptionGroup group)
Appends the usage clause for an OptionGroup to a StringBuffer.
|
protected String | createPadding(int len) Return a String of padding of length |
protected int | findWrapPos(String text, int width, int startPos)
Finds the next text wrap position after startPos for the
text in text with the column width width .
|
String | getArgName()
Returns the 'argName'.
|
int | getDescPadding()
Returns the 'descPadding'.
|
int | getLeftPadding()
Returns the 'leftPadding'.
|
String | getLongOptPrefix()
Returns the 'longOptPrefix'.
|
String | getNewLine()
Returns the 'newLine'.
|
String | getOptPrefix()
Returns the 'optPrefix'.
|
String | getSyntaxPrefix()
Returns the 'syntaxPrefix'.
|
int | getWidth()
Returns the 'width'.
|
void | printHelp(String cmdLineSyntax, Options options) Print the help for |
void | printHelp(String cmdLineSyntax, Options options, boolean autoUsage) Print the help for |
void | printHelp(String cmdLineSyntax, String header, Options options, String footer) Print the help for |
void | printHelp(String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage) Print the help for |
void | printHelp(int width, String cmdLineSyntax, String header, Options options, String footer) Print the help for |
void | printHelp(int width, String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage) Print the help for |
void | printHelp(PrintWriter pw, int width, String cmdLineSyntax, String header, Options options, int leftPad, int descPad, String footer) Print the help for |
void | printHelp(PrintWriter pw, int width, String cmdLineSyntax, String header, Options options, int leftPad, int descPad, String footer, boolean autoUsage) Print the help for |
void | printOptions(PrintWriter pw, int width, Options options, int leftPad, int descPad) Print the help for the specified Options to the specified writer, using the specified width, left padding and description padding. |
void | printUsage(PrintWriter pw, int width, String app, Options options) Prints the usage statement for the specified application. |
void | printUsage(PrintWriter pw, int width, String cmdLineSyntax) Print the cmdLineSyntax to the specified writer, using the specified width. |
void | printWrapped(PrintWriter pw, int width, String text) Print the specified text to the specified PrintWriter. |
void | printWrapped(PrintWriter pw, int width, int nextLineTabStop, String text) Print the specified text to the specified PrintWriter. |
protected StringBuffer | renderOptions(StringBuffer sb, int width, Options options, int leftPad, int descPad) Render the specified Options and return the rendered Options in a StringBuffer. |
protected StringBuffer | renderWrappedText(StringBuffer sb, int width, int nextLineTabStop, String text) Render the specified text and return the rendered Options in a StringBuffer. |
protected String | rtrim(String s) Remove the trailing whitespace from the specified String. |
void | setArgName(String name)
Sets the 'argName'.
|
void | setDescPadding(int padding)
Sets the 'descPadding'.
|
void | setLeftPadding(int padding)
Sets the 'leftPadding'.
|
void | setLongOptPrefix(String prefix)
Sets the 'longOptPrefix'.
|
void | setNewLine(String newline)
Sets the 'newLine'.
|
void | setOptPrefix(String prefix)
Sets the 'optPrefix'.
|
void | setSyntaxPrefix(String prefix)
Sets the 'syntaxPrefix'.
|
void | setWidth(int width)
Sets the 'width'.
|
Deprecated: Scope will be made private for next major version - use get/setArgName methods instead.
the name of the argumentDeprecated: Scope will be made private for next major version - use get/setDescPadding methods instead.
the number of characters of padding to be prefixed to each description lineDeprecated: Scope will be made private for next major version - use get/setLeftPadding methods instead.
amount of padding to the left of each lineDeprecated: Scope will be made private for next major version - use get/setLongOptPrefix methods instead.
the long Opt prefixDeprecated: Scope will be made private for next major version - use get/setNewLine methods instead.
the new line stringDeprecated: Scope will be made private for next major version - use get/setOptPrefix methods instead.
the shortOpt prefixDeprecated: Scope will be made private for next major version - use get/setSyntaxPrefix methods instead.
the string to display at the begining of the usage statementDeprecated: Scope will be made private for next major version - use get/setWidth methods instead.
number of characters per lineParameters: buff the StringBuffer to append to option the Option to append required whether the Option is required or not
Parameters: buff the StringBuffer to append to group the group to append
See Also: HelpFormatter
Return a String of padding of length len
.
Parameters: len The length of the String of padding to create.
Returns: The String of padding
startPos
for the
text in text
with the column width width
.
The wrap point is the last postion before startPos+width having a
whitespace character (space, \n, \r).
Parameters: text The text being searched for the wrap position width width of the wrapped text startPos position from which to start the lookup whitespace character
Returns: postion on which the text must be wrapped or -1 if the wrap position is at the end of the text
Returns: the 'argName'
Returns: the 'descPadding'
Returns: the 'leftPadding'
Returns: the 'longOptPrefix'
Returns: the 'newLine'
Returns: the 'optPrefix'
Returns: the 'syntaxPrefix'
Returns: the 'width'
Print the help for options
with the specified
command line syntax. This method prints help information to
System.out.
Parameters: cmdLineSyntax the syntax for this application options the Options instance
Print the help for options
with the specified
command line syntax. This method prints help information to
System.out.
Parameters: cmdLineSyntax the syntax for this application options the Options instance autoUsage whether to print an automatically generated usage statement
Print the help for options
with the specified
command line syntax. This method prints help information to
System.out.
Parameters: cmdLineSyntax the syntax for this application header the banner to display at the begining of the help options the Options instance footer the banner to display at the end of the help
Print the help for options
with the specified
command line syntax. This method prints help information to
System.out.
Parameters: cmdLineSyntax the syntax for this application header the banner to display at the begining of the help options the Options instance footer the banner to display at the end of the help autoUsage whether to print an automatically generated usage statement
Print the help for options
with the specified
command line syntax. This method prints help information to
System.out.
Parameters: width the number of characters to be displayed on each line cmdLineSyntax the syntax for this application header the banner to display at the begining of the help options the Options instance footer the banner to display at the end of the help
Print the help for options
with the specified
command line syntax. This method prints help information to
System.out.
Parameters: width the number of characters to be displayed on each line cmdLineSyntax the syntax for this application header the banner to display at the begining of the help options the Options instance footer the banner to display at the end of the help autoUsage whether to print an automatically generated usage statement
Print the help for options
with the specified
command line syntax.
Parameters: pw the writer to which the help will be written width the number of characters to be displayed on each line cmdLineSyntax the syntax for this application header the banner to display at the begining of the help options the Options instance leftPad the number of characters of padding to be prefixed to each line descPad the number of characters of padding to be prefixed to each description line footer the banner to display at the end of the help
Print the help for options
with the specified
command line syntax.
Parameters: pw the writer to which the help will be written width the number of characters to be displayed on each line cmdLineSyntax the syntax for this application header the banner to display at the begining of the help options the Options instance leftPad the number of characters of padding to be prefixed to each line descPad the number of characters of padding to be prefixed to each description line footer the banner to display at the end of the help autoUsage whether to print an automatically generated usage statement
Print the help for the specified Options to the specified writer, using the specified width, left padding and description padding.
Parameters: pw The printWriter to write the help to width The number of characters to display per line options The command line Options leftPad the number of characters of padding to be prefixed to each line descPad the number of characters of padding to be prefixed to each description line
Prints the usage statement for the specified application.
Parameters: pw The PrintWriter to print the usage statement width The number of characters to display per line app The application name options The command line Options
Print the cmdLineSyntax to the specified writer, using the specified width.
Parameters: pw The printWriter to write the help to width The number of characters per line for the usage statement. cmdLineSyntax The usage statement.
Print the specified text to the specified PrintWriter.
Parameters: pw The printWriter to write the help to width The number of characters to display per line text The text to be written to the PrintWriter
Print the specified text to the specified PrintWriter.
Parameters: pw The printWriter to write the help to width The number of characters to display per line nextLineTabStop The position on the next line for the first tab. text The text to be written to the PrintWriter
Render the specified Options and return the rendered Options in a StringBuffer.
Parameters: sb The StringBuffer to place the rendered Options into. width The number of characters to display per line options The command line Options leftPad the number of characters of padding to be prefixed to each line descPad the number of characters of padding to be prefixed to each description line
Returns: the StringBuffer with the rendered Options contents.
Render the specified text and return the rendered Options in a StringBuffer.
Parameters: sb The StringBuffer to place the rendered text into. width The number of characters to display per line nextLineTabStop The position on the next line for the first tab. text The text to be rendered.
Returns: the StringBuffer with the rendered Options contents.
Remove the trailing whitespace from the specified String.
Parameters: s The String to remove the trailing padding from.
Returns: The String of without the trailing padding
Parameters: name the new value of 'argName'
Parameters: padding the new value of 'descPadding'
Parameters: padding the new value of 'leftPadding'
Parameters: prefix the new value of 'longOptPrefix'
Parameters: newline the new value of 'newLine'
Parameters: prefix the new value of 'optPrefix'
Parameters: prefix the new value of 'syntaxPrefix'
Parameters: width the new value of 'width'