Package org.apache.rat.help

Class Help

java.lang.Object

org.apache.rat.help.AbstractHelp

org.apache.rat.help.Help

public class Help
extends AbstractHelp

The help output for the command line client.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.rat.help.AbstractHelp

AbstractHelp.RatHelpFormatter

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	NOTES	An array of notes to go at the bottom of the help output
protected final PrintWriter	writer	The writer this instance writes to

Fields inherited from class org.apache.rat.help.AbstractHelp

DEPRECATED_MSG, HELP_PADDING, HELP_WIDTH, helpFormatter, versionInfo

Constructor Summary

Constructors

Constructor	Description
Help(PrintStream stream)	Creates a Help instance to print to the specified stream.
Help(Writer writer)	Creates a Help instance to write to the specified writer.

Method Summary

Modifier and Type	Method	Description
String	printArgumentTypes()	Prints the list of argument types to the writer.
void	printUsage(org.apache.commons.cli.Options opts)	Print the usage to the specific PrintWriter.

Methods inherited from class org.apache.rat.help.AbstractHelp

createPadding, header

Methods inherited from class java.lang.Object

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

Field Details

NOTES

protected static final String[] NOTES

An array of notes to go at the bottom of the help output

writer

protected final PrintWriter writer

The writer this instance writes to

Constructor Details

Help

public Help(Writer writer)

Creates a Help instance to write to the specified writer.

Parameters:

writer - the writer to write to.

Help

public Help(PrintStream stream)

Creates a Help instance to print to the specified stream.

Parameters:

stream - the PrintStream to write to.

Method Details

printUsage

public void printUsage(org.apache.commons.cli.Options opts)

Print the usage to the specific PrintWriter.

Parameters:

opts - The defined options.

printArgumentTypes

public String printArgumentTypes()

Prints the list of argument types to the writer.

Returns:

returns the padding for the arguments.