Java org.apache.commons.cli HelpFormatter fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.commons.cli HelpFormatter.

The text is from its open source code.

Subclass

org.apache.commons.cli.HelpFormatter has subclasses.
Click this link to see all its subclasses.

Field

int	DEFAULT_WIDTH default number of characters per line
int	DEFAULT_LEFT_PAD default padding to the left of each line
int	DEFAULT_DESC_PAD the number of characters of padding to be prefixed to each description line

Constructor

	HelpFormatter

Method

int	getDescPadding() Returns the 'descPadding'.
int	getLeftPadding() Returns the 'leftPadding'.
String	getNewLine() Returns the 'newLine'.
int	getWidth() Returns the 'width'.
void	printHelp(String cmdLineSyntax, Options options) Print the help for `options` with the specified command line syntax.
void	printHelp(String cmdLineSyntax, Options options, boolean autoUsage) Print the help for `options` with the specified command line syntax.
void	printHelp(String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage) Print the help for `options` with the specified command line syntax.
void	printHelp(int width, String cmdLineSyntax, String header, Options options, String footer) Print the help for `options` with the specified command line syntax.
void	printHelp(String cmdLineSyntax, String header, Options options, String footer) Print the help for `options` with the specified command line syntax.
void	printHelp(PrintWriter pw, int width, String cmdLineSyntax, String header, Options options, int leftPad, int descPad, String footer, boolean autoUsage) Print the help for `options` with the specified command line syntax.
void	printHelp(int width, String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage) Print the help for `options` with the specified command line syntax.
void	printHelp(PrintWriter pw, int width, String cmdLineSyntax, String header, Options options, int leftPad, int descPad, String footer) Print the help for `options` with the specified command line syntax.
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.
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	setOptionComparator(Comparator comparator) Set the comparator used to sort the options when they output in help text Passing in a null parameter will set the ordering to the default mode
void	setOptPrefix(String prefix) Sets the 'optPrefix'.
void	setSyntaxPrefix(String prefix) Sets the 'syntaxPrefix'.
void	setWidth(int width) Sets the 'width'.