joptsimple

Class BuiltinHelpFormatter

java.lang.Object

joptsimple.BuiltinHelpFormatter

All Implemented Interfaces:

HelpFormatter

public class BuiltinHelpFormatter
extends Object
implements HelpFormatter

A help formatter that allows configuration of overall row width and column separator width.

The formatter produces output in two sections: one for the options, and one for non-option arguments.

The options section has two columns: the left column for the options, and the right column for their descriptions. The formatter will allow as much space as possible for the descriptions, by minimizing the option column's width, no greater than slightly less than half the overall desired width.

The non-option arguments section is one column, occupying as much width as it can.

Subclasses are free to override bits of this implementation as they see fit. Inspect the code carefully to understand the flow of control that this implementation guarantees.

Author:

Paul Holser

Constructor Summary

Constructors

Constructor and Description
BuiltinHelpFormatter(int desiredOverallWidth, int desiredColumnSeparatorWidth) Makes a formatter with a given overall row width and column separator width.

Method Summary

Modifier and Type	Method and Description
String	format(Map<String,? extends OptionDescriptor> options) Produces help text, given a set of option descriptors.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuiltinHelpFormatter

public BuiltinHelpFormatter(int desiredOverallWidth,
                            int desiredColumnSeparatorWidth)

Makes a formatter with a given overall row width and column separator width.

Parameters:

desiredOverallWidth - how many characters wide to make the overall help display

desiredColumnSeparatorWidth - how many characters wide to make the separation between option column and description column

Method Detail

format

public String format(Map<String,? extends OptionDescriptor> options)

Produces help text, given a set of option descriptors.

This implementation:

• Sorts the given descriptors by their first elements of OptionDescriptor.options()
• Passes the resulting sorted set to addRows(java.util.Collection)
• Returns the result of formattedHelpOutput()

Specified by:

format in interface HelpFormatter

Parameters:

options - descriptors for the configured options of a parser

Returns:

text to be used as help

See Also:

OptionParser.printHelpOn(java.io.Writer), OptionParser.formatHelpWith(HelpFormatter)