eu.toennies.javahttpobservatoryapi

Class HelpFormatter

java.lang.Object

eu.toennies.javahttpobservatoryapi.HelpFormatter

public class HelpFormatter
extends Object

This class is a utility class for printing the help message. It is based on the HelpFormatter class from the Apache CI project.

Author:

Sascha Tönnies

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SYNTAX_PREFIX the string to display at the beginning of the usage statement

Constructor Summary

Constructors

Constructor and Description
HelpFormatter(PrintWriter pw)

Method Summary

Modifier and Type	Method and Description
protected String	createPadding(int len) Return a String of padding of length len.
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.
int	getDescPadding()
String	getHeader() Print the header.
int	getLeftPadding()
String	getNewLine()
String	getSyntaxPrefix()
int	getWidth() Returns the 'width'.
void	printHelp(ApiCommands[] commands) Print the help for ApiCommands with the specified command line syntax.
void	printHelp(int width, String cmdLineSyntax, String header, ApiCommands[] commands, int leftPad, int descPad, String footer) Print the help for ApiCommands[] with the specified command line syntax.
void	printHelp(int width, String cmdLineSyntax, String header, ApiCommands[] commands, String footer) Print the help for ApiCommands[] with the specified command line syntax.
void	printOptions(int width, ApiCommands[] commands, 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(int width, String cmdLineSyntax) Print the cmdLineSyntax to the specified writer, using the specified width.
void	printWrapped(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	renderCommands(StringBuffer sb, int width, ApiCommands[] commands, int leftPad, int descPad) Render the specified ApiCommands and return the rendered ApiCommand 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	setDescPadding(int defaultDescPad)
void	setLeftPadding(int leftPad)
void	setNewLine(String defaultNewLine)
void	setSyntaxPrefix(String syntaxPrefix)
void	setWidth(int width)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SYNTAX_PREFIX

public static final String DEFAULT_SYNTAX_PREFIX

the string to display at the beginning of the usage statement

See Also:

Constant Field Values

Constructor Detail

HelpFormatter

public HelpFormatter(PrintWriter pw)

Method Detail

getNewLine

public String getNewLine()

Returns:

the defaultNewLine

setNewLine

public void setNewLine(String defaultNewLine)

Parameters:

defaultNewLine - the defaultNewLine to set

getSyntaxPrefix

public String getSyntaxPrefix()

Returns:

the syntaxPrefix

setSyntaxPrefix

public void setSyntaxPrefix(String syntaxPrefix)

Parameters:

syntaxPrefix - the syntaxPrefix to set

getLeftPadding

public int getLeftPadding()

Returns:

the leftPad

getDescPadding

public int getDescPadding()

Returns:

the defaultDescPad

setLeftPadding

public void setLeftPadding(int leftPad)

Parameters:

leftPad - the leftPad to set

setDescPadding

public void setDescPadding(int defaultDescPad)

Parameters:

defaultDescPad - the defaultDescPad to set

getWidth

public int getWidth()

Returns the 'width'.

Returns:

the 'width'

setWidth

public void setWidth(int width)

Parameters:

width - the defaultWidth to set

printHelp

public void printHelp(ApiCommands[] commands)

Print the help for ApiCommands with the specified command line syntax. This method prints help information to System.out.

Parameters:

commands - ApiCommands to format

printHelp

public void printHelp(int width,
                      String cmdLineSyntax,
                      String header,
                      ApiCommands[] commands,
                      String footer)

Print the help for ApiCommands[] 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 beginning of the help

commands - commands the Options instance

footer - the banner to display at the end of the help

printHelp

public void printHelp(int width,
                      String cmdLineSyntax,
                      String header,
                      ApiCommands[] commands,
                      int leftPad,
                      int descPad,
                      String footer)

Print the help for ApiCommands[] with the specified command line syntax.

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 beginning of the help

commands - the Commands 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

Throws:

IllegalStateException - if there is no room to print a line

printUsage

public void printUsage(int width,
                       String cmdLineSyntax)

Print the cmdLineSyntax to the specified writer, using the specified width.

Parameters:

width - The number of characters per line for the usage statement.

cmdLineSyntax - The usage statement.

printWrapped

public void printWrapped(PrintWriter pw,
                         int width,
                         int nextLineTabStop,
                         String text)

Print the specified text to the specified PrintWriter.

Parameters:

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

renderWrappedText

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

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.

findWrapPos

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. The wrap point is the last position before startPos+width having a whitespace character (space, \n, \r). If there is no whitespace character before startPos+width, it will return startPos+width.

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:

position on which the text must be wrapped or -1 if the wrap position is at the end of the text

rtrim

protected String rtrim(String s)

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

createPadding

protected String createPadding(int len)

Return a String of padding of length len.

Parameters:

len - The length of the String of padding to create.

Returns:

The String of padding

printWrapped

public void printWrapped(int width,
                         String text)

Print the specified text to the specified PrintWriter.

Parameters:

width - The number of characters to display per line

text - The text to be written to the PrintWriter

getHeader

public String getHeader()

Print the header.

printOptions

public void printOptions(int width,
                         ApiCommands[] commands,
                         int leftPad,
                         int descPad)

Print the help for the specified Options to the specified writer, using the specified width, left padding and description padding.

Parameters:

width - The number of characters to display per line

commands - commands

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

renderCommands

protected StringBuffer renderCommands(StringBuffer sb,
                                      int width,
                                      ApiCommands[] commands,
                                      int leftPad,
                                      int descPad)

Render the specified ApiCommands and return the rendered ApiCommand in a StringBuffer.

Parameters:

sb - The StringBuffer to place the rendered ApiCommand into.

width - The number of characters to display per line

commands - The command line ApiCommands

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.