joptsimple

Interface HelpFormatter

All Known Implementing Classes:

BuiltinHelpFormatter

public interface HelpFormatter

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

Author:

Paul Holser

Method Summary

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

Method Detail

format

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

Produces help text, given a set of option descriptors.

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)