Top Description Methods
jdk.internal.joptsimple

public Interface HelpFormatter

Known Direct Implementers
jdk.internal.joptsimple.BuiltinHelpFormatter
Imports
java.util.Map

Represents objects charged with taking a set of option descriptions and producing some help text from them.

Author
Paul Holser

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

text to be used as help
format(Map<String, ? extends OptionDescriptor>
descriptors for the configured options of a parser
options)

Produces help text, given a set of option descriptors.

Method Detail

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

Produces help text, given a set of option descriptors.

Parameters
options:Map<String, ? extends OptionDescriptor>

descriptors for the configured options of a parser

Returns:String

text to be used as help

See Also
OptionParser#printHelpOn(java.io.Writer), OptionParser#formatHelpWith(HelpFormatter)