A B C E F G H I L N O P R S T U

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 values to the key in the argument list.

addArg(String, String) - Method in class org.apache.rat.plugin.BaseRatMojo

Add a value to the key in the argument list.

addEclipseDefaults(Log, boolean) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addIdeaDefaults(Log, boolean) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addIgnoreMatcher(IgnoreMatcher) - Method in class org.apache.rat.mp.util.ignore.IgnoringDirectoryScanner

addMavenDefaults(Log, boolean) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addPlexusAndScmDefaults(Log, boolean) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addRule(String) - Method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

Add a single rule to the set

addRules(Collection<String>) - Method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

Add a set of rules to the set

All - Class in org.apache.rat.mp

All() - Constructor for class org.apache.rat.mp.All

Any - Class in org.apache.rat.mp

Any() - Constructor for class org.apache.rat.mp.Any

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

build() - Method in class org.apache.rat.mp.Any

build() - Method in class org.apache.rat.mp.Copyright

build() - Method in class org.apache.rat.mp.Family

build(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.mp.License

build() - Method in class org.apache.rat.mp.Not

C

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

check() - Method in class org.apache.rat.mp.RatCheckMojo

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

Actions when closing the report.

ConfigurationHelper - Class in org.apache.rat.mp.util

Copyright - Class in org.apache.rat.mp

Copyright() - Constructor for class org.apache.rat.mp.Copyright

createName(String) - Static method in class org.apache.rat.plugin.BaseRatMojo

E

ExclusionHelper - Class in org.apache.rat.mp.util

This class encapsulates the file/directory exclusion handling of RAT.

ExclusionHelper() - Constructor for class org.apache.rat.mp.util.ExclusionHelper

execute() - Method in class org.apache.rat.apache_rat_plugin.HelpMojo

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.

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

Family() - Constructor for class org.apache.rat.mp.Family

G

generate(Sink, Locale) - Method in class org.apache.rat.mp.RatReportMojo

Deprecated.

use RatReportMojo.generate(Sink, SinkFactory, Locale) instead.

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.

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

Returns the license matchers class name.

getConfiguration() - Method in class org.apache.rat.mp.AbstractRatMojo

getDefaultsBuilder() - Method in class org.apache.rat.mp.AbstractRatMojo

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

Returns the reports description.

getExclusionLines() - Method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

getExclusionsFromSCM(Log, File) - Static method in class org.apache.rat.mp.util.ScmIgnoreParser

Parse ignore files from all known SCMs that have ignore files.

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.

GitIgnoreMatcher - Class in org.apache.rat.mp.util.ignore

GitIgnoreMatcher(Log, File) - Constructor for class org.apache.rat.mp.util.ignore.GitIgnoreMatcher

GlobIgnoreMatcher - Class in org.apache.rat.mp.util.ignore

GlobIgnoreMatcher() - Constructor for class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

GlobIgnoreMatcher(Log, File) - Constructor for class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

H

HeaderMatcherSpecification - Class in org.apache.rat.mp

Used to specify additional license matchers.

HeaderMatcherSpecification() - Constructor for class org.apache.rat.mp.HeaderMatcherSpecification

HelpMojo - Class in org.apache.rat.apache_rat_plugin

Display help information on apache-rat-plugin.

HelpMojo() - Constructor for class org.apache.rat.apache_rat_plugin.HelpMojo

I

IgnoreMatcher - Interface in org.apache.rat.mp.util.ignore

IgnoringDirectoryScanner - Class in org.apache.rat.mp.util.ignore

IgnoringDirectoryScanner() - Constructor for class org.apache.rat.mp.util.ignore.IgnoringDirectoryScanner

isComment(String) - Static method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

Determines whether the given line is a comment or not based on scanning for prefixes

isEmpty() - Method in class org.apache.rat.mp.util.ignore.GitIgnoreMatcher

isEmpty() - Method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

isEmpty() - Method in interface org.apache.rat.mp.util.ignore.IgnoreMatcher

Returns true if this IgnoreMatcher contains no rules.

isExcluded(String) - Method in class org.apache.rat.mp.util.ignore.IgnoringDirectoryScanner

isExcluded(String, String[]) - Method in class org.apache.rat.mp.util.ignore.IgnoringDirectoryScanner

isExcluded(String, char[][]) - Method in class org.apache.rat.mp.util.ignore.IgnoringDirectoryScanner

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

isIgnoredFile(String) - Method in class org.apache.rat.mp.util.ignore.GitIgnoreMatcher

isIgnoredFile(String) - Method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

isIgnoredFile(String) - Method in interface org.apache.rat.mp.util.ignore.IgnoreMatcher

Checks if the file matches the stored expressions.

L

License - Class in org.apache.rat.mp

License() - Constructor for class org.apache.rat.mp.License

loadFile(Log, File) - Method in class org.apache.rat.mp.util.ignore.GlobIgnoreMatcher

Parses excludes from the given SCM ignore file.

logLicenses(Collection<ILicense>) - Method in class org.apache.rat.mp.AbstractRatMojo

N

newInstance(Class<T>, String) - Static method in class org.apache.rat.mp.util.ConfigurationHelper

Not - Class in org.apache.rat.mp

Not() - Constructor for class org.apache.rat.mp.Not

O

org.apache.rat.apache_rat_plugin - package org.apache.rat.apache_rat_plugin

org.apache.rat.mp - package org.apache.rat.mp

org.apache.rat.mp.util - package org.apache.rat.mp.util

org.apache.rat.mp.util.ignore - package org.apache.rat.mp.util.ignore

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 in org.apache.rat.mp

RatCheckException(String) - Constructor for exception 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

Regex() - Constructor for class org.apache.rat.mp.Regex

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

ScmIgnoreParser - Class in org.apache.rat.mp.util

Helper to parse SCM ignore files to add entries as excludes during RAT runs.

session - Variable in class org.apache.rat.mp.RatReportMojo

The local repository.

set(String) - Method in class org.apache.rat.mp.Regex

set(String) - Method in class org.apache.rat.mp.Spdx

set(String) - Method in class org.apache.rat.mp.Text

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>

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

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.

setCopyrightMessage(String) - Method in class org.apache.rat.mp.RatCheckMojo

Deprecated.

Deprecated for removal since 0.17: Use <editCopyright> instead.

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.

setExpr(String) - Method in class org.apache.rat.mp.Regex

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.

setInputExclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo

Excludes files matching wildcard <Expression>.

setInputExcludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo

Excludes files matching regular expression in the input file.

setInputExcludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo

Excludes files matching wildcard <Expression>.

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 approved 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

setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.Any

setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.License

setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.Not

setNoDefaultLicenses(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo

Deprecated.

Deprecated for removal since 0.17: Use <configurationNoDefaults> instead.

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.

setReportFile(File) - Method in class org.apache.rat.mp.RatCheckMojo

Deprecated.

use 'out' property.

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

setScanHiddenDirectories(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo

Scans hidden directories.

setStylesheet(String) - Method in class org.apache.rat.plugin.BaseRatMojo

Deprecated.

Deprecated for removal since 0.17: Use <outputStyle> instead.

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

Spdx() - Constructor for class org.apache.rat.mp.Spdx

T

Text - Class in org.apache.rat.mp

Text() - Constructor for class org.apache.rat.mp.Text

toString() - Method in class org.apache.rat.mp.Family

toString() - Method in class org.apache.rat.mp.License

toString() - Method in class org.apache.rat.mp.util.ignore.GitIgnoreMatcher

U

unsupportedArgs() - Static method in class org.apache.rat.plugin.BaseRatMojo

A B C E F G H I L N O P R S T U