Index

A B C E F G H I L N O P R S T U 
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractRatMojo - Class in org.apache.rat.mp
Abstract base class for Mojos, which are running Rat.
AbstractRatMojo() - Constructor for class org.apache.rat.mp.AbstractRatMojo
 
addArg(String, String) - Method in class org.apache.rat.plugin.BaseRatMojo
Add a value to the key in the argument list.
addArg(String, String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Add values to the key in the argument list.
All - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
All() - Constructor for class org.apache.rat.mp.All
Deprecated.
 
Any - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Any() - Constructor for class org.apache.rat.mp.Any
Deprecated.
 
args - Variable in class org.apache.rat.plugin.BaseRatMojo
A map of CLI based arguments to values.
args() - Method in class org.apache.rat.plugin.BaseRatMojo
Gets the list of arguments prepared for the CLI code to parse.

B

BaseRatMojo - Class in org.apache.rat.plugin
Generated class to provide Maven support for standard RAT command line options
BaseRatMojo() - Constructor for class org.apache.rat.plugin.BaseRatMojo
 
build() - Method in class org.apache.rat.mp.All
Deprecated.
 
build() - Method in class org.apache.rat.mp.Any
Deprecated.
 
build() - Method in class org.apache.rat.mp.Copyright
Deprecated.
 
build() - Method in class org.apache.rat.mp.Family
Deprecated.
 
build() - Method in class org.apache.rat.mp.Not
Deprecated.
 
build(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.mp.License
Deprecated.
 

C

canGenerateReport() - Method in class org.apache.rat.mp.RatReportMojo
 
check(ReportConfiguration) - Method in class org.apache.rat.mp.RatCheckMojo
 
closeReport() - Method in class org.apache.rat.mp.RatReportMojo
Actions when closing the report.
Copyright - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Copyright() - Constructor for class org.apache.rat.mp.Copyright
Deprecated.
 
createName(String) - Static method in class org.apache.rat.plugin.BaseRatMojo
Creates a Maven name from a long option.

E

execute() - Method in class org.apache.rat.mp.RatCheckMojo
Invoked by Maven to execute the Mojo.
execute() - Method in class org.apache.rat.mp.RatReportMojo
This method is called when the report generation is invoked directly as a standalone Mojo.
execute() - Method in class org.apache.rat.plugin.HelpMojo
executeReport(Locale) - Method in class org.apache.rat.mp.RatReportMojo
Writes the report to the Doxia sink.

F

Family - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Family() - Constructor for class org.apache.rat.mp.Family
Deprecated.
 

G

generate(Sink, Locale) - Method in class org.apache.rat.mp.RatReportMojo
Deprecated.
use RatReportMojo.generate(Sink, SinkFactory, Locale) instead.
generate(Sink, SinkFactory, Locale) - Method in class org.apache.rat.mp.RatReportMojo
This method is called when the report generation is invoked by maven-site-plugin.
generate(Sink, Locale) - Method in class org.apache.rat.mp.RatReportMojo
Deprecated.
use RatReportMojo.generate(Sink, SinkFactory, Locale) instead.
getArg(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Get the list of values for a key.
getCategoryName() - Method in class org.apache.rat.mp.RatReportMojo
 
getClassName() - Method in class org.apache.rat.mp.HeaderMatcherSpecification
Deprecated.
Returns the license matchers class name.
getConfiguration() - Method in class org.apache.rat.mp.AbstractRatMojo
 
getConfiguration() - Method in class org.apache.rat.mp.RatCheckMojo
 
getDefaultsBuilder() - Method in class org.apache.rat.mp.AbstractRatMojo
 
getDescription(Locale) - Method in class org.apache.rat.mp.RatReportMojo
Returns the reports description.
getInputEncoding() - Method in class org.apache.rat.mp.RatReportMojo
Gets the input files encoding.
getName(Locale) - Method in class org.apache.rat.mp.RatReportMojo
Returns the reports name.
getOutputDirectory() - Method in class org.apache.rat.mp.RatReportMojo
 
getOutputEncoding() - Method in class org.apache.rat.mp.RatReportMojo
Gets the effective reporting output files encoding.
getOutputName() - Method in class org.apache.rat.mp.RatReportMojo
Returns the reports file name.
getProject() - Method in class org.apache.rat.mp.AbstractRatMojo
 
getRatTxtFile() - Method in class org.apache.rat.mp.RatCheckMojo
Reads the location of the RAT text file from the Mojo.
getReportOutputDirectory() - Method in class org.apache.rat.mp.RatReportMojo
 
getSink() - Method in class org.apache.rat.mp.RatReportMojo
 
getSinkFactory() - Method in class org.apache.rat.mp.RatReportMojo
 
getSiteRenderer() - Method in class org.apache.rat.mp.RatReportMojo
 
getValues(Arg) - Method in class org.apache.rat.mp.AbstractRatMojo
Reads values for the Arg.

H

HeaderMatcherSpecification - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
HeaderMatcherSpecification() - Constructor for class org.apache.rat.mp.HeaderMatcherSpecification
Deprecated.
 
HelpMojo - Class in org.apache.rat.plugin
Display help information on apache-rat-plugin.
Call mvn apache-rat:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.apache.rat.plugin.HelpMojo
 

I

isExternalReport() - Method in class org.apache.rat.mp.RatReportMojo
 

L

License - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
License() - Constructor for class org.apache.rat.mp.License
Deprecated.
 
logLicenses(Collection<ILicense>) - Method in class org.apache.rat.mp.AbstractRatMojo
 

N

Not - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Not() - Constructor for class org.apache.rat.mp.Not
Deprecated.
 

O

org.apache.rat.mp - package org.apache.rat.mp
The base package for the RAT Maven plugin.
org.apache.rat.plugin - package org.apache.rat.plugin
 
outputDirectory - Variable in class org.apache.rat.mp.RatReportMojo
The output directory for the report.

P

project - Variable in class org.apache.rat.mp.AbstractRatMojo
Holds the maven-internal project to allow resolution of artifact properties during mojo runs.

R

RatCheckException - Exception Class in org.apache.rat.mp
Exception thrown when Plugin processing encounters an error not found in Core system.
RatCheckException(String) - Constructor for exception class org.apache.rat.mp.RatCheckException
 
RatCheckMojo - Class in org.apache.rat.mp
Run Rat to perform a violation check.
RatCheckMojo() - Constructor for class org.apache.rat.mp.RatCheckMojo
 
RatReportMojo - Class in org.apache.rat.mp
Generates a report with Rat's output.
RatReportMojo() - Constructor for class org.apache.rat.mp.RatReportMojo
 
Regex - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Regex() - Constructor for class org.apache.rat.mp.Regex
Deprecated.
 
remoteRepositories - Variable in class org.apache.rat.mp.RatReportMojo
Remote repositories used for the project.
removeArg(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Remove a key from the argument list.
removeKey(Arg) - Method in class org.apache.rat.mp.AbstractRatMojo
Removes all values for an Arg.

S

session - Variable in class org.apache.rat.mp.RatReportMojo
The local repository.
set(String) - Method in class org.apache.rat.mp.Regex
Deprecated.
 
set(String) - Method in class org.apache.rat.mp.Spdx
Deprecated.
 
set(String) - Method in class org.apache.rat.mp.Text
Deprecated.
 
setAddDefaultLicenses(boolean) - Method in class org.apache.rat.mp.AbstractRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead (note the change of state).
setAddLicense(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <editLicense> instead.
setAddLicenseHeaders(String) - Method in class org.apache.rat.mp.RatCheckMojo
Deprecated.
Use <editLicense> and <editOverwrite>.
setAll(All) - Method in class org.apache.rat.mp.All
Deprecated.
 
setAll(All) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setAll(All) - Method in class org.apache.rat.mp.License
Deprecated.
 
setAll(All) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setAny(Any) - Method in class org.apache.rat.mp.All
Deprecated.
 
setAny(Any) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setAny(Any) - Method in class org.apache.rat.mp.License
Deprecated.
 
setAny(Any) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setArg(String, String) - Method in class org.apache.rat.plugin.BaseRatMojo
Set a key and value into the argument list.
setClassName(String) - Method in class org.apache.rat.mp.HeaderMatcherSpecification
Deprecated.
Sets the license matchers class name.
setConfig(String) - Method in class org.apache.rat.plugin.BaseRatMojo
File names for system configuration.
setConfigs(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
File names for system configuration.
setConfigurationNoDefaults(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Ignore default configuration.
setCopyright(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.
setCopyright(Copyright) - Method in class org.apache.rat.mp.All
Deprecated.
 
setCopyright(Copyright) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setCopyright(Copyright) - Method in class org.apache.rat.mp.License
Deprecated.
 
setCopyright(Copyright) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setCopyrightMessage(String) - Method in class org.apache.rat.mp.RatCheckMojo
Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.
setCounterMax(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The acceptable maximum number for the specified counter.
setCounterMaxs(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
The acceptable maximum number for the specified counter.
setCounterMin(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The minimum number for the specified counter.
setCounterMins(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
The minimum number for the specified counter.
setDryRun(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
If set do not update the files but generate the reports.
setEditCopyright(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The copyright message to use in the license headers.
setEditLicense(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Add the default license header to any file with an unknown license that is not in the exclusion list.
setEditOverwrite(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Forces any changes in files to be written directly to the source files (i.e. new files are not created).
setExclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.
setExcludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputExcludeFile> instead.
setExcludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.
setExpression(String) - Method in class org.apache.rat.mp.Regex
Deprecated.
 
setForce(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <editOverwrite> instead.
setHelpLicenses(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Print information about registered licenses.
setInclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.
setIncludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.
setIncludesFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeFile> instead.
setInputExclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Excludes files matching <Expression>.
setInputExcludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Reads <Expression> entries from a file.
setInputExcludeParsedScm(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Parse SCM based exclusion files to exclude specified files and directories.
setInputExcludeParsedScms(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Parse SCM based exclusion files to exclude specified files and directories.
setInputExcludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Excludes files matching <Expression>.
setInputExcludeSize(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Excludes files with sizes less than the given argument.
setInputExcludeStd(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Excludes files defined in standard collections based on commonly occurring groups.
setInputExcludeStds(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Excludes files defined in standard collections based on commonly occurring groups.
setInputInclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Includes files matching <Expression>.
setInputIncludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Reads <Expression> entries from a file.
setInputIncludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Includes files matching <Expression>.
setInputIncludeStd(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Includes files defined in standard collections based on commonly occurring groups.
setInputIncludeStds(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Includes files defined in standard collections based on commonly occurring groups.
setInputSource(String) - Method in class org.apache.rat.plugin.BaseRatMojo
A file containing file names to process.
setInputSources(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
A file containing file names to process.
setLicenseFamiliesApproved(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The approved License Family IDs.
setLicenseFamiliesApproved(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
The approved License Family IDs.
setLicenseFamiliesApprovedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Name of file containing the approved family IDs.
setLicenseFamiliesDenied(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The denied License family IDs.
setLicenseFamiliesDenied(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
The denied License family IDs.
setLicenseFamiliesDeniedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Name of file containing the denied license IDs.
setLicenses(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <config> instead.
setLicenses(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <config> instead.
setLicensesApproved(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The approved License IDs.
setLicensesApproved(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
The approved License IDs.
setLicensesApprovedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Name of file containing the approved License IDs.
setLicensesDenied(String) - Method in class org.apache.rat.plugin.BaseRatMojo
The denied License IDs.
setLicensesDenied(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo
The denied License IDs.
setLicensesDeniedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Name of file containing the denied license IDs.
setListFamilies(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <outputFamilies> instead.
setListLicenses(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <outputLicenses> instead.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.All
Deprecated.
 
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.License
Deprecated.
 
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setNoDefaultLicenses(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead.
setNot(Not) - Method in class org.apache.rat.mp.All
Deprecated.
 
setNot(Not) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setNot(Not) - Method in class org.apache.rat.mp.License
Deprecated.
 
setNot(Not) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setOut(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <outputFile> instead.
setOutputArchive(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Specifies the level of detail in ARCHIVE file reporting.
setOutputFamilies(String) - Method in class org.apache.rat.plugin.BaseRatMojo
List the defined license families.
setOutputFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Define the output file where to write a report to.
setOutputLicenses(String) - Method in class org.apache.rat.plugin.BaseRatMojo
List the defined licenses.
setOutputStandard(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Specifies the level of detail in STANDARD file reporting.
setOutputStyle(String) - Method in class org.apache.rat.plugin.BaseRatMojo
XSLT stylesheet to use when creating the report.
setRegex(Regex) - Method in class org.apache.rat.mp.All
Deprecated.
 
setRegex(Regex) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setRegex(Regex) - Method in class org.apache.rat.mp.License
Deprecated.
 
setRegex(Regex) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setReportFile(File) - Method in class org.apache.rat.mp.RatCheckMojo
Deprecated.
Use 'out' property instead.
setReportOutputDirectory(File) - Method in class org.apache.rat.mp.RatReportMojo
 
setReportStyle(String) - Method in class org.apache.rat.mp.RatCheckMojo
Deprecated.
Use setStyleSheet or xml instead.
setScanHiddenDirectories(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.
setSpdx(Spdx) - Method in class org.apache.rat.mp.All
Deprecated.
 
setSpdx(Spdx) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setSpdx(Spdx) - Method in class org.apache.rat.mp.License
Deprecated.
 
setSpdx(Spdx) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setStylesheet(String) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> instead.
setText(Text) - Method in class org.apache.rat.mp.All
Deprecated.
 
setText(Text) - Method in class org.apache.rat.mp.Any
Deprecated.
 
setText(Text) - Method in class org.apache.rat.mp.License
Deprecated.
 
setText(Text) - Method in class org.apache.rat.mp.Not
Deprecated.
 
setXml(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo
Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> with the 'xml' argument instead.
siteRenderer - Variable in class org.apache.rat.mp.RatReportMojo
Doxia Site Renderer component.
siteTool - Variable in class org.apache.rat.mp.RatReportMojo
SiteTool.
skip - Variable in class org.apache.rat.mp.AbstractRatMojo
Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
Spdx - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Spdx() - Constructor for class org.apache.rat.mp.Spdx
Deprecated.
 

T

Text - Class in org.apache.rat.mp
Deprecated.
use Configuration file to define licenses
Text() - Constructor for class org.apache.rat.mp.Text
Deprecated.
 
toKebabForm(String) - Static method in class org.apache.rat.plugin.BaseRatMojo
Creates a kebab case name from a camel case name.
toString() - Method in class org.apache.rat.mp.Family
Deprecated.
 
toString() - Method in class org.apache.rat.mp.License
Deprecated.
 

U

unsupportedArgs() - Static method in class org.apache.rat.plugin.BaseRatMojo
Returns the list of unsupported args.
A B C E F G H I L N O P R S T U 
All Classes and Interfaces|All Packages|Serialized Form