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

 

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

 

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

 

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

 

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

 

C

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

Returns, whether the report may be generated.

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

 

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

 

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

Creates the report as a string.

createReport(Writer, InputStream) - Method in class org.apache.rat.mp.AbstractRatMojo

Writes the report to the given stream.

D

DOT_HTML - Static variable in class org.apache.rat.mp.RatReportMojo

 

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.mp.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

Called from Maven to invoke the plugin.

G

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

Writes the report to the Doxia sink.

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

Returns the reports category name.

getClassName() - Method in class org.apache.rat.mp.HeaderMatcherSpecification

Returns the license matchers class name.

getClassName() - Method in class org.apache.rat.mp.LicenseFamilySpecification

Returns the license familys class name.

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

 

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

 

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

Returns the reports description.

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

Parses excludes from the given SCM ignore file.

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

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

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

Returns the reports name.

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

Returns the reports file name.

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

 

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

Returns the reports output directory.

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

Creates an iterator over the files to check.

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.mp

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.mp.HelpMojo

 

I

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

Returns, whether this is an external report.

L

LicenseFamilySpecification - Class in org.apache.rat.mp

Used to specify additional license families.

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

 

N

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

 

O

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

 

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

 

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

 

S

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

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

setClassName(String) - Method in class org.apache.rat.mp.HeaderMatcherSpecification

Sets the license matchers class name.

setClassName(String) - Method in class org.apache.rat.mp.LicenseFamilySpecification

Sets the license family's class name.

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

Sets the reports output directory.

skip - Variable in class org.apache.rat.mp.AbstractRatMojo

Will skip the plugin execution, e.g.