Top Description Methods

com.beust.jcommander

public Interface IUsageFormatter

Known Direct Implementers: com.beust.jcommander.DefaultUsageFormatter

A formatter for help messages.

Method Summary

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

Method Detail

getCommandDescription	back to summary
public String getCommandDescription(String commandName) Returns:String the description of the argument command

usage	back to summary
public void usage(String commandName) Display the usage for this command.

usage	back to summary
public void usage(String commandName, StringBuilder out) Store the help for the command in the passed string builder.

usage	back to summary
public void usage(StringBuilder out) Store the help in the passed string builder.

usage	back to summary
public 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	back to summary
public void usage(StringBuilder out, String indent) Stores the help in the passed string builder, with the argument indentation.