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

Example usage for Java org.apache.commons.cli2.util HelpFormatter fields, constructors, methods, implement or subclass

Introduction

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

The text is from its open source code.

Constructor

HelpFormatter()
Creates a new HelpFormatter using the defaults
HelpFormatter(final String gutterLeft, final String gutterCenter, final String gutterRight, final int fullWidth)
Creates a new HelpFormatter using the specified parameters

Method

SetgetDisplaySettings()
SetgetFullUsageSettings()
SetgetLineUsageSettings()
intgetPageWidth()
voidprint()
Prints the Option help.
voidprintFooter()
Prints a footer string if necessary
voidprintHeader()
Prints a header string if necessary
voidprintHelp()
Prints detailed help per option.
voidprintUsage()
Prints a single line of usage information (wrapping if necessary)
voidsetDivider(String divider)
Sets the string to use as a divider between sections of help
voidsetException(OptionException exception)
Sets the exception to document
voidsetFooter(String footer)
Sets the footer text of the help screen
voidsetGroup(Group group)
Sets the Group of Options to document
voidsetHeader(String header)
Sets the footer text of the help screen
voidsetPrintWriter(PrintWriter out)
voidsetShellCommand(String shellCommand)
Sets the command string used to invoke the application