Package org.apache.rat.help

Class Licenses

java.lang.Object

org.apache.rat.help.AbstractHelp

org.apache.rat.help.Licenses

public final class Licenses
extends AbstractHelp

Generates text based documentation for Licenses, LicenceFamilies, and Matchers. Utilizes the same command line as the CLI based Report client so that additional licenses, etc. can be added.

Nested Class Summary

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

AbstractHelp.RatHelpFormatter

Field Summary

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

DEPRECATED_MSG, HELP_PADDING, HELP_WIDTH, helpFormatter, versionInfo

Constructor Summary

Constructors

Constructor	Description
Licenses(UIOptionCollection<?> uiOptionCollection, ReportConfiguration config, Writer writer)	Constructor

Method Summary

Modifier and Type	Method	Description
void	output()	Output the License information without the version information.
void	printHelp()	Print the help text with the version information.

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

Constructor Details

Licenses

public Licenses(UIOptionCollection<?> uiOptionCollection,
 ReportConfiguration config,
 Writer writer)

Constructor

Parameters:

uiOptionCollection - the option collection to generate the help for.

config - The configuration that contains the license information.

writer - the writer to write the report to.

Method Details

printHelp

public void printHelp()
               throws IOException

Print the help text with the version information.

Throws:

IOException - on output error.

output

public void output()
            throws IOException

Output the License information without the version information.

Throws:

IOException - on error.