org.apache.commons.cli
Class HelpFormatter

java.lang.Object
  |
  +--org.apache.commons.cli.HelpFormatter

public class HelpFormatter

extends java.lang.Object

A formatter of help messages for the current command line options

Author:

Slawek Zachcial, John Keyes (john at integralsource.com)

Field Summary

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 Summary

HelpFormatter()

Method Summary

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

DEFAULT_LEFT_PAD

public static final int DEFAULT_LEFT_PAD

DEFAULT_DESC_PAD

public static final int DEFAULT_DESC_PAD

DEFAULT_SYNTAX_PREFIX

public static final java.lang.String DEFAULT_SYNTAX_PREFIX

DEFAULT_OPT_PREFIX

public static final java.lang.String DEFAULT_OPT_PREFIX

DEFAULT_LONG_OPT_PREFIX

public static final java.lang.String DEFAULT_LONG_OPT_PREFIX

DEFAULT_ARG_NAME

public static final java.lang.String DEFAULT_ARG_NAME

defaultWidth

public int defaultWidth

defaultLeftPad

public int defaultLeftPad

defaultDescPad

public int defaultDescPad

defaultSyntaxPrefix

public java.lang.String defaultSyntaxPrefix

defaultNewLine

public java.lang.String defaultNewLine

defaultOptPrefix

public java.lang.String defaultOptPrefix

defaultLongOptPrefix

public java.lang.String defaultLongOptPrefix

defaultArgName

public java.lang.String defaultArgName

Constructor Detail

HelpFormatter

public HelpFormatter()

Method Detail

printHelp

public void printHelp(java.lang.String cmdLineSyntax,
                      Options options)

printHelp

public void printHelp(java.lang.String cmdLineSyntax,
                      Options options,
                      boolean autoUsage)

printHelp

public void printHelp(java.lang.String cmdLineSyntax,
                      java.lang.String header,
                      Options options,
                      java.lang.String footer)

printHelp

public void printHelp(java.lang.String cmdLineSyntax,
                      java.lang.String header,
                      Options options,
                      java.lang.String footer,
                      boolean autoUsage)

printHelp

public void printHelp(int width,
                      java.lang.String cmdLineSyntax,
                      java.lang.String header,
                      Options options,
                      java.lang.String footer)

printHelp

public void printHelp(int width,
                      java.lang.String cmdLineSyntax,
                      java.lang.String header,
                      Options options,
                      java.lang.String footer,
                      boolean autoUsage)

printHelp

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

printHelp

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

printUsage

public void printUsage(java.io.PrintWriter pw,
                       int width,
                       java.lang.String app,
                       Options options)

Prints the usage statement for the specified application.

Parameters:

pw - The PrintWriter to print the usage statement

width - ??

appName - The application name

options - The command line Options

printUsage

public void printUsage(java.io.PrintWriter pw,
                       int width,
                       java.lang.String cmdLineSyntax)

printOptions

public void printOptions(java.io.PrintWriter pw,
                         int width,
                         Options options,
                         int leftPad,
                         int descPad)

printWrapped

public void printWrapped(java.io.PrintWriter pw,
                         int width,
                         java.lang.String text)

printWrapped

public void printWrapped(java.io.PrintWriter pw,
                         int width,
                         int nextLineTabStop,
                         java.lang.String text)

renderOptions

protected java.lang.StringBuffer renderOptions(java.lang.StringBuffer sb,
                                               int width,
                                               Options options,
                                               int leftPad,
                                               int descPad)

renderWrappedText

protected java.lang.StringBuffer renderWrappedText(java.lang.StringBuffer sb,
                                                   int width,
                                                   int nextLineTabStop,
                                                   java.lang.String text)

findWrapPos

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. The wrap point is the last postion before startPos+width having a whitespace character (space, \n, \r).

Parameters:

sb - text to be analyzed

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

createPadding

protected java.lang.String createPadding(int len)

rtrim

protected java.lang.String rtrim(java.lang.String s)