org.sonatype.gshell.util.cli2
Class HelpPrinter

java.lang.Object
  org.sonatype.gshell.util.cli2.HelpPrinter

public class HelpPrinter
extends Object

Helper to print formatted help and usage text.

Since:

2.3

Author:

Jason Dillon

Constructor Summary

HelpPrinter(CliProcessor processor)

Method Summary

void	addMessages(MessageSource messages)
String	getPrefix()
String	getSeparator()
int	getTerminalWidth()
void	printArguments(PrintWriter out, List<ArgumentDescriptor> arguments)
void	printOptions(PrintWriter out, List<OptionDescriptor> options)
void	printUsage(PrintWriter writer)
void	printUsage(PrintWriter out, String name)
void	setPrefix(String prefix)
void	setSeparator(String separator)
void	setTerminalWidth(int terminalWidth)

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpPrinter

public HelpPrinter(CliProcessor processor)

Method Detail

addMessages

public void addMessages(MessageSource messages)

getTerminalWidth

public int getTerminalWidth()

setTerminalWidth

public void setTerminalWidth(int terminalWidth)

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

getSeparator

public String getSeparator()

setSeparator

public void setSeparator(String separator)

printUsage

public void printUsage(PrintWriter out,
                       String name)

printArguments

public void printArguments(PrintWriter out,
                           List<ArgumentDescriptor> arguments)

Since:

2.4

printOptions

public void printOptions(PrintWriter out,
                         List<OptionDescriptor> options)

Since:

2.4

printUsage

public void printUsage(PrintWriter writer)