All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AbstractClaimReporter Abstract base implementation ofAbstractReport.AbstractLicenseAppender Add a license header to a document.AbstractMonolithicDocument Abstract base class for monolithic documents.AbstractRatMojo Abstract base class for Mojos, which are running Rat.AbstractReport Abstract base class for deriving implementations ofRatReport.AcademicFree21LicenseFamily AddLicenseHeaders Value of addLicenseHeaders configuration option.Apache20LicenseFamily ApacheSoftwareLicense20 Matches Apache License, Version 2.0ApacheV2LicenseAppender Add an Apache License V2 license header to a document.AppliedApacheSoftwareLicense20 Matches an applied AL 2.0 License header, including a required initial copyright header line, conforming the template from the AL 2.0 license itself.ArchiveEntryDocument ArchiveGuesser ArchiveWalker Walks various kinds of archives filesArrayCharFilter BaseLicense BinaryGuesser TODO: factor into MIME guesser and MIME->binary guesserBOMInputStream Stripped down version of Commons IO 2.0's BOMInputStream.CDDL1License Base CDDL 1.0 license.CDDL1LicenseFamily Base implementation for CDDL 1.0 licenses.CharFilter ClaimAggregator The aggregator is used to create a numerical statistic of claims.ClaimReporterMultiplexer ClaimStatistic This class provides a numerical overview about the report.CompositeDocumentException Indicates that the document is a composite archive and cannot be read.ConfigurationHelper ConfigurationUtil ContentType Describe the MIME content type of a resource.CopyrightHeader Matches a typical Copyright header line only based on a regex pattern which allows for one (starting) year or year range, and a configurable copyright owner.DefaultAnalyserFactory Creates default analysers.DefaultAnalyserFactory.DefaultAnalyser DefaultPolicy Defaults Utility class that holds constants shared by the CLI tool and the Ant tasks.DirectoryWalker Walks directories.Document DocumentAnalyserMultiplexer DocumentHeaderAnalyser DocumentImplUtils DojoLicenseHeader ExclusionHelper This class encapsulates the file/directory exclusion handling of RAT.FileDocument Document wrapping a file of undetermined composition.FileNameComparator FilesReportable Implementation of IReportable that traverses over a set of files.FilteringSequenceFactory FullTextLicenseMatcher AdaptsFullTextMatchingLicenseto Ant's method naming conventions so it becomes easy to write text matching based license matchers inside an Ant build file.FullTextMatchingLicense Accumulates all letters and numbers contained inside the header and compares it to the full text of a given license (after reducing it to letters and numbers as well).GeneratedLicenseNotRequired GPL1License License matches GPL1 or later.GPL1LicenseFamily Base implementation for GPLv1 or later.GPL2License License matches GPL2 or later.GPL2LicenseFamily Base implementation for GPLv2 or later.GPL3License License matches GPL3 or later.GPL3LicenseFamily Base implementation for GPLv3 or later.GuessUtils HeaderBean HeaderCheckWorker Reads from a stream to check license.HeaderMatcher Matches headers.HeaderMatcherMultiplexer Delegates to an ordered set of matchers.HeaderMatcherSpecification Used to specify additional license matchers.HelpMojo Display help information on apache-rat-plugin.
Callmvn apache-rat:help -Ddetail=true -Dgoal=<goal-name>to display parameter details.IDocumentAnalyser IHeaderMatcher Matches text headers to known licenses.ILicenseFamily InvalidXmlException Indicates that the requested document would not be well formed.IReportable IXmlWriter Simple interface for creating basic xml documents.JavaDocLicenseNotRequired JavaDocs are generated and so no license is required.LicenseAddingReport LicenseFamily Licenses are grouped into families.LicenseFamilyBuilder BuildsLicenseFamilyinstances.LicenseFamilySpecification Used to specify additional license families.MetaData Data about the subject.MetaData.Datum A datum.MimeTyper Discovers the mime type of content.MITLicense Base MIT license (all 3 parts).MITLicenseFamily Base implementation for MIT licenses.ModifiedBSDLicenseFamily MonolithicFileDocument NoteGuesser OASISLicense Looks for documents contain the OASIS copyright claim plus derivative work clause.OASISLicenseFamily OperationNotAllowedException Thrown byIXmlWriterimplementations when the current state does not allow the requested operation.RatCheckException RatCheckMojo Run Rat to perform a violation check.RatDocumentAnalysisException RatException RatHeaderAnalysisException Indicates exceptional condition during header analysis.RatLicenseFamily Enumerates standard license families known to Rat.RatReport RatReportAnalysisResultException RatReportMojo Generates a report with Rat's output.Report A basic Ant task that generates a report on all files specified by the nested resource collection(s).Report Report.AddLicenseHeaders Type for the addLicenseHeaders attribute.Report.Format Type for the format attribute.ReportConfiguration A configuration object is used by the frontend to invoke theReport.ReportFailedRuntimeException Indicates that a report has failed in a fatal manner.ReportFormat ReportTransformer ResourceCollectionContainer Implementation of IReportable that traverses over a resource collection internally.ScmIgnoreParser Helper to parse SCM ignore files to add entries as excludes during RAT runs.SimpleLicenseFamily Trivial bean implementing ILicenseFamilySimplePatternBasedLicense SimpleXmlClaimReporter SourceCodeManagementSystems SubstringLicenseMatcher AdaptsSimplePatternBasedLicenseto Ant's method naming conventions so it becomes easy to write substring based license matchers inside an Ant build file.SubstringLicenseMatcher.Pattern A simple wrapper around a substring.TMF854LicenseHeader ToNameTransformer UnsuitableDocumentException Indicates that the document was unsuitable for analysis.W3CDocLicense W3CDocumentLicenseFamily W3CLicense W3CSoftwareLicenseFamily Walker Abstract walker.XmlReportFactory Creates reports.XmlWriter LightweightIXmlWriterimplementation.XmlWriterUtils