Package com.beust.jcommander

Interface IUsageFormatter

All Known Implementing Classes:

DefaultUsageFormatter, UnixStyleUsageFormatter

public interface IUsageFormatter

A formatter for help messages.

Method Summary

Modifier and Type	Method	Description
String	getCommandDescription(String commandName)
void	usage(String commandName)	Display the usage for this command.
void	usage(StringBuilder out)	Store the help in the passed string builder.
void	usage(StringBuilder out, String indent)	Stores the help in the passed string builder, with the argument indentation.
void	usage(String commandName, StringBuilder out)	Store the help for the command in the passed string builder.
void	usage(String commandName, StringBuilder out, String indent)	Store the help for the command in the passed string builder, indenting every line with "indent".

Method Details

usage

void usage(String commandName)

Display the usage for this command.

usage

void usage(String commandName,
 StringBuilder out)

Store the help for the command in the passed string builder.

usage

void usage(StringBuilder out)

Store the help in the passed string builder.

usage

void usage(String commandName,
 StringBuilder out,
 String indent)

Store the help for the command in the passed string builder, indenting every line with "indent".

usage

void usage(StringBuilder out,
 String indent)

Stores the help in the passed string builder, with the argument indentation.

getCommandDescription

String getCommandDescription(String commandName)

Returns:

the description of the argument command