Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X 

A

AbstractClaimReporter - Class in org.apache.rat.report.claim.impl
Abstract base implementation of AbstractReport.
AbstractClaimReporter() - Constructor for class org.apache.rat.report.claim.impl.AbstractClaimReporter
 
AbstractLicenseAppender - Class in org.apache.rat.annotation
Add a license header to a document.
AbstractLicenseAppender() - Constructor for class org.apache.rat.annotation.AbstractLicenseAppender
 
AbstractMonolithicDocument - Class in org.apache.rat.document.impl
Abstract base class for monolithic documents.
AbstractMonolithicDocument(String) - Constructor for class org.apache.rat.document.impl.AbstractMonolithicDocument
 
AbstractReport - Class in org.apache.rat.report
Abstract base class for deriving implementations of RatReport.
AbstractReport() - Constructor for class org.apache.rat.report.AbstractReport
 
AcademicFree21LicenseFamily - Class in org.apache.rat.license
 
AcademicFree21LicenseFamily() - Constructor for class org.apache.rat.license.AcademicFree21LicenseFamily
 
add(MetaData.Datum) - Method in class org.apache.rat.api.MetaData
Adds a new datum.
AddLicenseHeaders - Enum in org.apache.rat.config
Value of addLicenseHeaders configuration option.
analyse(Document) - Method in class org.apache.rat.analysis.DocumentHeaderAnalyser
 
analyse(Document) - Method in interface org.apache.rat.document.IDocumentAnalyser
 
analyse(Document) - Method in class org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer
 
analyse(Document) - Method in class org.apache.rat.policy.DefaultPolicy
 
Apache20LicenseFamily - Class in org.apache.rat.license
 
Apache20LicenseFamily() - Constructor for class org.apache.rat.license.Apache20LicenseFamily
 
ApacheSoftwareLicense20 - Class in org.apache.rat.analysis.license
Matches Apache License, Version 2.0
ApacheSoftwareLicense20() - Constructor for class org.apache.rat.analysis.license.ApacheSoftwareLicense20
 
ApacheV2LicenseAppender - Class in org.apache.rat.annotation
Add an Apache License V2 license header to a document.
ApacheV2LicenseAppender() - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender
Create a license appender with the standard ASF license header.
ApacheV2LicenseAppender(String) - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender
Create a license appender with the given copyright line.
append(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Append the default license header to the supplied document.
AppliedApacheSoftwareLicense20 - Class in org.apache.rat.analysis.license
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.
AppliedApacheSoftwareLicense20() - Constructor for class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20
 
AppliedApacheSoftwareLicense20(String) - Constructor for class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20
 
ARCHIVE_TYPE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
ARCHIVE_TYPE_READABLE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
ARCHIVE_TYPE_UNREADABLE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
ArchiveEntryDocument - Class in org.apache.rat.document.impl
 
ArchiveEntryDocument(File, byte[]) - Constructor for class org.apache.rat.document.impl.ArchiveEntryDocument
 
ArchiveGuesser - Class in org.apache.rat.document.impl.guesser
 
ArchiveGuesser() - Constructor for class org.apache.rat.document.impl.guesser.ArchiveGuesser
 
ArchiveWalker - Class in org.apache.rat.walker
Walks various kinds of archives files
ArchiveWalker(File, FilenameFilter) - Constructor for class org.apache.rat.walker.ArchiveWalker
Constructs a walker.
AS_IS_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.MITLicense
 
ASCII_CHAR_THREASHOLD - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
ASL20_LICENSE_DEFN - Static variable in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20
 
attribute(CharSequence, CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
Writes an attribute of an element.
attribute(CharSequence, CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter
Writes an attribute of an element.

B

BaseLicense - Class in org.apache.rat.analysis.license
 
BaseLicense() - Constructor for class org.apache.rat.analysis.license.BaseLicense
 
BaseLicense(MetaData.Datum, MetaData.Datum, String) - Constructor for class org.apache.rat.analysis.license.BaseLicense
 
BinaryGuesser - Class in org.apache.rat.document.impl.guesser
TODO: factor into MIME guesser and MIME->binary guesser
BinaryGuesser() - Constructor for class org.apache.rat.document.impl.guesser.BinaryGuesser
 

C

CDDL1_LICENSE_DEFN - Static variable in class org.apache.rat.analysis.license.CDDL1License
 
CDDL1_LICENSE_DEFN_ILLUMOS_STYLE - Static variable in class org.apache.rat.analysis.license.CDDL1License
 
CDDL1License - Class in org.apache.rat.analysis.license
Base CDDL 1.0 license.
CDDL1License() - Constructor for class org.apache.rat.analysis.license.CDDL1License
 
CDDL1LicenseFamily - Class in org.apache.rat.license
Base implementation for CDDL 1.0 licenses.
CDDL1LicenseFamily() - Constructor for class org.apache.rat.license.CDDL1LicenseFamily
 
ClaimAggregator - Class in org.apache.rat.report.claim.impl
The aggregator is used to create a numerical statistic of claims.
ClaimAggregator(ClaimStatistic) - Constructor for class org.apache.rat.report.claim.impl.ClaimAggregator
 
ClaimReporterMultiplexer - Class in org.apache.rat.report.claim.util
 
ClaimReporterMultiplexer(IDocumentAnalyser, List<? extends RatReport>) - Constructor for class org.apache.rat.report.claim.util.ClaimReporterMultiplexer
 
ClaimStatistic - Class in org.apache.rat.report.claim
This class provides a numerical overview about the report.
ClaimStatistic() - Constructor for class org.apache.rat.report.claim.ClaimStatistic
 
clear(String) - Method in class org.apache.rat.api.MetaData
Removes all data matching the given name.
clear() - Method in class org.apache.rat.api.MetaData
Clears all data.
closeDocument() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
Closes all pending elements.
closeDocument() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter
Closes all pending elements.
closeElement() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
Closes the last element written.
closeElement() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter
Closes the last element written.
COMPARATOR - Static variable in class org.apache.rat.walker.DirectoryWalker
 
CompositeDocumentException - Exception in org.apache.rat.document
Indicates that the document is a composite archive and cannot be read.
CompositeDocumentException() - Constructor for exception org.apache.rat.document.CompositeDocumentException
 
CompositeDocumentException(String) - Constructor for exception org.apache.rat.document.CompositeDocumentException
 
ConfigurationUtil - Class in org.apache.rat.config
 
ConfigurationUtil() - Constructor for class org.apache.rat.config.ConfigurationUtil
 
containsExtension(String, String[]) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
content(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
Writes content.
content(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter
Writes content.
ContentType - Class in org.apache.rat.api
Describe the MIME content type of a resource.
ContentType(String, String, Map<String, String>) - Constructor for class org.apache.rat.api.ContentType
Constructs content types, performing an necessary conversions.
COPYRIGHT_PREFIX_PATTERN_DEFN - Static variable in class org.apache.rat.analysis.license.CopyrightHeader
 
CopyrightHeader - Class in org.apache.rat.analysis.license
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.
CopyrightHeader() - Constructor for class org.apache.rat.analysis.license.CopyrightHeader
 
CopyrightHeader(MetaData.Datum, MetaData.Datum, String) - Constructor for class org.apache.rat.analysis.license.CopyrightHeader
 
CopyrightHeader(MetaData.Datum, MetaData.Datum, String, String) - Constructor for class org.apache.rat.analysis.license.CopyrightHeader
 
createDefaultAnalyser(IHeaderMatcher) - Static method in class org.apache.rat.analysis.DefaultAnalyserFactory
 
createDefaultMatcher() - Static method in class org.apache.rat.Defaults
 
createStandardReport(IXmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory
 

D

Datum(String, String) - Constructor for class org.apache.rat.api.MetaData.Datum
Constructs a datum.
DEFAULT_LICENSE_FAMILIES - Static variable in class org.apache.rat.Defaults
 
DEFAULT_MATCHERS - Static variable in class org.apache.rat.Defaults
The standard list of licenses to include in the reports.
DefaultAnalyserFactory - Class in org.apache.rat.analysis
Creates default analysers.
DefaultAnalyserFactory() - Constructor for class org.apache.rat.analysis.DefaultAnalyserFactory
 
DefaultPolicy - Class in org.apache.rat.policy
 
DefaultPolicy(ILicenseFamily[], boolean) - Constructor for class org.apache.rat.policy.DefaultPolicy
 
DefaultPolicy(List<String>, boolean) - Constructor for class org.apache.rat.policy.DefaultPolicy
 
Defaults - Class in org.apache.rat
Utility class that holds constants shared by the CLI tool and the Ant tasks.
DirectoryWalker - Class in org.apache.rat.walker
Walks directories.
DirectoryWalker(File) - Constructor for class org.apache.rat.walker.DirectoryWalker
 
DirectoryWalker(File, FilenameFilter) - Constructor for class org.apache.rat.walker.DirectoryWalker
Constructs a walker.
DirectoryWalker(File, Pattern) - Constructor for class org.apache.rat.walker.DirectoryWalker
 
Document - Interface in org.apache.rat.api
 
DocumentAnalyserMultiplexer - Class in org.apache.rat.document.impl.util
 
DocumentAnalyserMultiplexer(IDocumentAnalyser[]) - Constructor for class org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer
 
DocumentHeaderAnalyser - Class in org.apache.rat.analysis
 
DocumentHeaderAnalyser(IHeaderMatcher) - Constructor for class org.apache.rat.analysis.DocumentHeaderAnalyser
 
DocumentImplUtils - Class in org.apache.rat.document.impl
 
DocumentImplUtils() - Constructor for class org.apache.rat.document.impl.DocumentImplUtils
 
DojoLicenseHeader - Class in org.apache.rat.analysis.license
 
DojoLicenseHeader() - Constructor for class org.apache.rat.analysis.license.DojoLicenseHeader
 

E

endReport() - Method in class org.apache.rat.report.AbstractReport
 
endReport() - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
endReport() - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
endReport() - Method in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer
 
endReport() - Method in interface org.apache.rat.report.RatReport
 
extensionMatches(String, String[]) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 

F

file - Variable in class org.apache.rat.walker.Walker
 
FILE_TYPE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
FileDocument - Class in org.apache.rat.document.impl
Document wrapping a file of undetermined composition.
FileDocument(File) - Constructor for class org.apache.rat.document.impl.FileDocument
 
fillClaimStatistic(ClaimStatistic) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
filter - Variable in class org.apache.rat.walker.Walker
 
FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.ApacheSoftwareLicense20
 
FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.GPL1License
 
FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.GPL2License
 
FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.GPL3License
 
FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.MITLicense
 
FullTextMatchingLicense - Class in org.apache.rat.analysis.license
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).
FullTextMatchingLicense() - Constructor for class org.apache.rat.analysis.license.FullTextMatchingLicense
 
FullTextMatchingLicense(MetaData.Datum, MetaData.Datum, String, String) - Constructor for class org.apache.rat.analysis.license.FullTextMatchingLicense
 

G

GeneratedLicenseNotRequired - Class in org.apache.rat.analysis.generation
 
GeneratedLicenseNotRequired() - Constructor for class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired
 
GeneratedLicenseNotRequired(Pattern[]) - Constructor for class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired
 
GeneratedLicenseNotRequired(String[]) - Constructor for class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired
 
get(String) - Method in class org.apache.rat.api.MetaData
Gets the first datum matching the given name.
getApprovedLicenseNames() - Method in class org.apache.rat.policy.DefaultPolicy
 
getApprovedLicenseNames() - Method in class org.apache.rat.ReportConfiguration
Returns the set of approved license names.
getContentType() - Method in class org.apache.rat.api.MetaData
Gets the content type for the subject.
getCopyrightMessage() - Method in class org.apache.rat.ReportConfiguration
 
getCopyRightOwner() - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
getData() - Method in class org.apache.rat.api.MetaData
Gets all data.
getDefaultStyleSheet() - Static method in class org.apache.rat.Defaults
 
getDocumentCategoryMap() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getExclusions() - Method in enum org.apache.rat.config.SourceCodeManagementSystems
If an ignore file exists it's added as *⁄.scm⁄* .
getFamilyName() - Method in interface org.apache.rat.license.ILicenseFamily
 
getFamilyName() - Method in class org.apache.rat.license.SimpleLicenseFamily
 
getFirstLine(int) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Get the first line of the license header formatted for the given type of file.
getHeaderMatcher() - Method in class org.apache.rat.ReportConfiguration
Returns the header matcher.
getHeaderPattern() - Method in class org.apache.rat.header.HeaderBean
Gets the header pattern to be matched.
getIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems
Maybe null, check before with
getInputFileFilter() - Method in class org.apache.rat.Report
Gets the current filter used to select files.
getLastLine(int) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Get the last line of the license header formatted for the given type of file.
getLicenseFamilyCategory() - Method in class org.apache.rat.analysis.license.BaseLicense
 
getLicenseFamilyName() - Method in class org.apache.rat.analysis.license.BaseLicense
 
getLicenseFileCodeMap() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getLicenseFileNameMap() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getLicenseHeader(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
 
getLicenseHeader(File) - Method in class org.apache.rat.annotation.ApacheV2LicenseAppender
 
getLine(int, String) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Get a line of the license header formatted for the given type of file.
getMediaType() - Method in class org.apache.rat.api.ContentType
Gets the media type, normalised to lower case.
getMetaData() - Method in interface org.apache.rat.api.Document
Gets data describing this resource.
getMetaData() - Method in class org.apache.rat.document.impl.AbstractMonolithicDocument
 
getMetaData() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
 
getMetaData() - Method in class org.apache.rat.document.impl.FileDocument
 
getName() - Method in interface org.apache.rat.api.Document
 
getName() - Method in class org.apache.rat.api.MetaData.Datum
Gets the name of the data type.
getName() - Method in class org.apache.rat.document.impl.AbstractMonolithicDocument
 
getName() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
 
getName() - Method in class org.apache.rat.document.impl.FileDocument
 
getNotes() - Method in class org.apache.rat.analysis.license.BaseLicense
 
getNumApproved() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getNumGenerated() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getNumUnApproved() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getNumUnknown() - Method in class org.apache.rat.report.claim.ClaimStatistic
 
getParameters() - Method in class org.apache.rat.api.ContentType
Gets an immutable map containing all content type parameters with keys normalised to lower case.
getPatterns() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
getPlainStyleSheet() - Static method in class org.apache.rat.Defaults
 
getPluginExclusions() - Static method in enum org.apache.rat.config.SourceCodeManagementSystems
Calls SourceCodeManagementSystems.getExclusions() on each SCM to generate a global list of exclusions to be used during RAT runs.
getSubType() - Method in class org.apache.rat.api.ContentType
Gets the media sub type normalised to lower case
getType(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Detect the type of document.
getUnapprovedLicensesStyleSheet() - Static method in class org.apache.rat.Defaults
 
getValue() - Method in class org.apache.rat.api.MetaData.Datum
Data type value.
getValuesForHelp() - Static method in enum org.apache.rat.config.AddLicenseHeaders
 
GPL1License - Class in org.apache.rat.analysis.license
License matches GPL1 or later.
GPL1License() - Constructor for class org.apache.rat.analysis.license.GPL1License
 
GPL1LicenseFamily - Class in org.apache.rat.license
Base implementation for GPLv1 or later.
GPL1LicenseFamily() - Constructor for class org.apache.rat.license.GPL1LicenseFamily
 
GPL2License - Class in org.apache.rat.analysis.license
License matches GPL2 or later.
GPL2License() - Constructor for class org.apache.rat.analysis.license.GPL2License
 
GPL2LicenseFamily - Class in org.apache.rat.license
Base implementation for GPLv2 or later.
GPL2LicenseFamily() - Constructor for class org.apache.rat.license.GPL2LicenseFamily
 
GPL3License - Class in org.apache.rat.analysis.license
License matches GPL3 or later.
GPL3License() - Constructor for class org.apache.rat.analysis.license.GPL3License
 
GPL3LicenseFamily - Class in org.apache.rat.license
Base implementation for GPLv3 or later.
GPL3LicenseFamily() - Constructor for class org.apache.rat.license.GPL3LicenseFamily
 
GuessUtils - Class in org.apache.rat.document.impl.guesser
 
GuessUtils() - Constructor for class org.apache.rat.document.impl.guesser.GuessUtils
 

H

handleApprovedLicenseClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
 
handleApprovedLicenseClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
handleDocumentCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
 
handleDocumentCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
handleHeaderCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
 
handleHeaderCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
handleLicenseFamilyNameClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
 
handleLicenseFamilyNameClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
hasCopyrightPattern() - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
hasFullText() - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense
 
hasIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems
 
HEADER_SAMPLE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
HEADER_TYPE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
HeaderBean - Class in org.apache.rat.header
 
HeaderBean() - Constructor for class org.apache.rat.header.HeaderBean
 
HeaderBean(Pattern, boolean) - Constructor for class org.apache.rat.header.HeaderBean
 
HeaderMatcher - Class in org.apache.rat.header
Matches headers.
HeaderMatcher(CharFilter, int) - Constructor for class org.apache.rat.header.HeaderMatcher
 
HeaderMatcher(CharFilter, int, HeaderBean[]) - Constructor for class org.apache.rat.header.HeaderMatcher
 
HeaderMatcherMultiplexer - Class in org.apache.rat.analysis.util
Delegates to an ordered set of matchers.
HeaderMatcherMultiplexer(List<IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.util.HeaderMatcherMultiplexer
 
HIGH_BYTES_RATIO - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 

I

IDocumentAnalyser - Interface in org.apache.rat.document
 
ignored(File) - Method in class org.apache.rat.walker.Walker
 
IHeaderMatcher - Interface in org.apache.rat.analysis
Matches text headers to known licenses.
ILicenseFamily - Interface in org.apache.rat.license
 
inputStream() - Method in interface org.apache.rat.api.Document
Streams the document's contents.
inputStream() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
 
inputStream() - Method in class org.apache.rat.document.impl.FileDocument
 
inputStream() - Method in class org.apache.rat.document.impl.MonolithicFileDocument
 
InvalidXmlException - Exception in org.apache.rat.report.xml.writer
Indicates that the requested document would not be well formed.
InvalidXmlException(String) - Constructor for exception org.apache.rat.report.xml.writer.InvalidXmlException
 
IReportable - Interface in org.apache.rat.report
 
is(String) - Method in enum org.apache.rat.config.ReportFormat
 
isAddingLicenses() - Method in class org.apache.rat.ReportConfiguration
 
isAddingLicensesForced() - Method in class org.apache.rat.ReportConfiguration
 
isApproveDefaultLicenses() - Method in class org.apache.rat.ReportConfiguration
 
isArchive(Document) - Static method in class org.apache.rat.document.impl.guesser.ArchiveGuesser
 
isArchive(String) - Static method in class org.apache.rat.document.impl.guesser.ArchiveGuesser
 
isBinary(Reader) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isBinary(InputStream) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isBinary(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isBinary(Document) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isBinaryData(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isBytecode(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isComposite() - Method in interface org.apache.rat.api.Document
Is this a composite document?
isComposite() - Method in class org.apache.rat.document.impl.AbstractMonolithicDocument
 
isComposite() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
 
isComposite() - Method in class org.apache.rat.document.impl.FileDocument
 
isCopyrightMatch() - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
isExecutable(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isImage(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isKeystore(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isMatch() - Method in class org.apache.rat.header.HeaderBean
 
isNonBinary(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
isNote(String) - Static method in class org.apache.rat.document.impl.guesser.NoteGuesser
 
isNote(Document) - Static method in class org.apache.rat.document.impl.guesser.NoteGuesser
 
isRestricted() - Method in class org.apache.rat.walker.DirectoryWalker
 
isRestricted(File) - Method in class org.apache.rat.walker.Walker
 
isZip(File) - Static method in class org.apache.rat.document.impl.DocumentImplUtils
 
isZipStream(InputStream) - Static method in class org.apache.rat.document.impl.DocumentImplUtils
 
IXmlWriter - Interface in org.apache.rat.report.xml.writer
Simple interface for creating basic xml documents.

J

JAR_MANIFEST - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
JAVA - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
JavaDocLicenseNotRequired - Class in org.apache.rat.analysis.generation
JavaDocs are generated and so no license is required.
JavaDocLicenseNotRequired() - Constructor for class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired
 

L

LICENSE_APPROVAL_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
LICENSE_FAMILY_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
LICENSE_REFERENCE_LINE - Static variable in class org.apache.rat.analysis.license.ApacheSoftwareLicense20
 
LicenseAddingReport - Class in org.apache.rat.report.claim.util
 
LicenseAddingReport(String, boolean) - Constructor for class org.apache.rat.report.claim.util.LicenseAddingReport
 
lines() - Method in class org.apache.rat.header.HeaderMatcher
Number of lines read.

M

main(String[]) - Static method in class org.apache.rat.Report
 
match(Document, String) - Method in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired
 
match(Document, String) - Method in class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired
 
match(Document, String) - Method in interface org.apache.rat.analysis.IHeaderMatcher
Matches the text accumulated to licenses.
match(Document, String) - Method in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20
 
match(Document, String) - Method in class org.apache.rat.analysis.license.CDDL1License
 
match(Document, String) - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
match(Document, String) - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense
 
match(Document, String) - Method in class org.apache.rat.analysis.license.OASISLicense
 
match(Document, String) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
match(Document, String) - Method in class org.apache.rat.analysis.util.HeaderMatcherMultiplexer
 
matchCopyright(String) - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
matches(String) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
matches(Pattern) - Method in class org.apache.rat.header.HeaderMatcher
Seeks a match in the last headers read.
MetaData - Class in org.apache.rat.api
Data about the subject.
MetaData() - Constructor for class org.apache.rat.api.MetaData
 
MetaData(ContentType) - Constructor for class org.apache.rat.api.MetaData
 
MetaData.Datum - Class in org.apache.rat.api
A datum.
MIDDLE_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.MITLicense
 
MimeTyper - Interface in org.apache.rat.api
Discovers the mime type of content.
MITLicense - Class in org.apache.rat.analysis.license
Base MIT license (all 3 parts).
MITLicense() - Constructor for class org.apache.rat.analysis.license.MITLicense
 
MITLicenseFamily - Class in org.apache.rat.license
Base implementation for MIT licenses.
MITLicenseFamily() - Constructor for class org.apache.rat.license.MITLicenseFamily
 
ModifiedBSDLicenseFamily - Class in org.apache.rat.license
 
ModifiedBSDLicenseFamily() - Constructor for class org.apache.rat.license.ModifiedBSDLicenseFamily
 
MonolithicFileDocument - Class in org.apache.rat.document.impl
 
MonolithicFileDocument(File) - Constructor for class org.apache.rat.document.impl.MonolithicFileDocument
 

N

name - Variable in class org.apache.rat.walker.Walker
 
newInstance(URL) - Static method in class org.apache.rat.document.impl.MonolithicFileDocument
 
NON_ASCII_THREASHOLD - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
normalise(String) - Static method in class org.apache.rat.document.impl.guesser.GuessUtils
Converts name to upper case and strips any path.
NoteGuesser - Class in org.apache.rat.document.impl.guesser
 
NoteGuesser() - Constructor for class org.apache.rat.document.impl.guesser.NoteGuesser
 

O

OASISLicense - Class in org.apache.rat.analysis.license
Looks for documents contain the OASIS copyright claim plus derivative work clause.
OASISLicense() - Constructor for class org.apache.rat.analysis.license.OASISLicense
 
OASISLicenseFamily - Class in org.apache.rat.license
 
OASISLicenseFamily() - Constructor for class org.apache.rat.license.OASISLicenseFamily
 
openElement(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
Writes the start of an element.
openElement(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter
Writes the start of an element.
OperationNotAllowedException - Exception in org.apache.rat.report.xml.writer
Thrown by IXmlWriter implementations when the current state does not allow the requested operation.
OperationNotAllowedException(String) - Constructor for exception org.apache.rat.report.xml.writer.OperationNotAllowedException
 
org.apache.rat - package org.apache.rat
 
org.apache.rat.analysis - package org.apache.rat.analysis
 
org.apache.rat.analysis.generation - package org.apache.rat.analysis.generation
 
org.apache.rat.analysis.license - package org.apache.rat.analysis.license
 
org.apache.rat.analysis.util - package org.apache.rat.analysis.util
 
org.apache.rat.annotation - package org.apache.rat.annotation
 
org.apache.rat.api - package org.apache.rat.api
Key abstractions.
org.apache.rat.config - package org.apache.rat.config
Contains source code management / revision control information used during plugin runs.
org.apache.rat.document - package org.apache.rat.document
 
org.apache.rat.document.impl - package org.apache.rat.document.impl
 
org.apache.rat.document.impl.guesser - package org.apache.rat.document.impl.guesser
 
org.apache.rat.document.impl.util - package org.apache.rat.document.impl.util
 
org.apache.rat.header - package org.apache.rat.header
 
org.apache.rat.license - package org.apache.rat.license
 
org.apache.rat.policy - package org.apache.rat.policy
 
org.apache.rat.report - package org.apache.rat.report
 
org.apache.rat.report.claim - package org.apache.rat.report.claim
 
org.apache.rat.report.claim.impl - package org.apache.rat.report.claim.impl
 
org.apache.rat.report.claim.impl.xml - package org.apache.rat.report.claim.impl.xml
 
org.apache.rat.report.claim.util - package org.apache.rat.report.claim.util
 
org.apache.rat.report.xml - package org.apache.rat.report.xml
 
org.apache.rat.report.xml.writer - package org.apache.rat.report.xml.writer
 
org.apache.rat.report.xml.writer.impl.base - package org.apache.rat.report.xml.writer.impl.base
 
org.apache.rat.walker - package org.apache.rat.walker
 

P

PLAIN_STYLESHEET - Static variable in class org.apache.rat.Defaults
 
prune(String) - Static method in class org.apache.rat.analysis.license.BaseLicense
 

R

RAT_APPROVED_LICENSE_DATIM_FALSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_APPROVED_LICENSE_DATIM_TRUE - Static variable in class org.apache.rat.api.MetaData
 
RAT_APPROVED_LICENSE_VALUE_FALSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_APPROVED_LICENSE_VALUE_TRUE - Static variable in class org.apache.rat.api.MetaData
 
RAT_BASE_URL - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_DATUM_BINARY - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_DATUM_GENERATED - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_DATUM_NOTICE - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_DATUM_STANDARD - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_VALUE_BINARY - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_VALUE_GENERATED - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_VALUE_NOTICE - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_VALUE_STANDARD - Static variable in class org.apache.rat.api.MetaData
 
RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_MIT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3 - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_MIT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData
 
RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData
 
RAT_REPORT - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
RAT_URL_APPROVED_LICENSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_URL_DOCUMENT_CATEGORY - Static variable in class org.apache.rat.api.MetaData
 
RAT_URL_HEADER_CATEGORY - Static variable in class org.apache.rat.api.MetaData
 
RAT_URL_HEADER_SAMPLE - Static variable in class org.apache.rat.api.MetaData
 
RAT_URL_LICENSE_FAMILY_CATEGORY - Static variable in class org.apache.rat.api.MetaData
 
RAT_URL_LICENSE_FAMILY_NAME - Static variable in class org.apache.rat.api.MetaData
 
RatDocumentAnalysisException - Exception in org.apache.rat.document
 
RatDocumentAnalysisException() - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
 
RatDocumentAnalysisException(String) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
 
RatDocumentAnalysisException(Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
 
RatDocumentAnalysisException(String, Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
 
RatException - Exception in org.apache.rat.api
 
RatException() - Constructor for exception org.apache.rat.api.RatException
 
RatException(String, Throwable) - Constructor for exception org.apache.rat.api.RatException
 
RatException(String) - Constructor for exception org.apache.rat.api.RatException
 
RatException(Throwable) - Constructor for exception org.apache.rat.api.RatException
 
RatHeaderAnalysisException - Exception in org.apache.rat.analysis
Indicates exceptional condition during header analysis.
RatHeaderAnalysisException() - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
 
RatHeaderAnalysisException(String, Throwable) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
 
RatHeaderAnalysisException(String) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
 
RatHeaderAnalysisException(Throwable) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
 
RatReport - Interface in org.apache.rat.report
 
RatReportAnalysisResultException - Exception in org.apache.rat.analysis
 
RatReportAnalysisResultException() - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException
 
RatReportAnalysisResultException(RatException) - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException
 
RatReportAnalysisResultException(String, RatException) - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException
 
read(Reader) - Method in class org.apache.rat.header.HeaderMatcher
 
reader() - Method in interface org.apache.rat.api.Document
Reads the content of this document.
reader() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
 
reader() - Method in class org.apache.rat.document.impl.FileDocument
 
reader() - Method in class org.apache.rat.document.impl.MonolithicFileDocument
 
regexFilter(Pattern) - Static method in class org.apache.rat.walker.Walker
 
Report - Class in org.apache.rat
 
report(Document) - Method in class org.apache.rat.report.AbstractReport
 
report(Document) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
 
report(Document) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
report(Document) - Method in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer
 
report(Document) - Method in class org.apache.rat.report.claim.util.LicenseAddingReport
 
report(Document) - Method in interface org.apache.rat.report.RatReport
 
report(PrintStream) - Method in class org.apache.rat.Report
report(PrintStream, ReportConfiguration) - Method in class org.apache.rat.Report
 
report(PrintStream, IReportable, InputStream, ReportConfiguration) - Static method in class org.apache.rat.Report
Output a report that is styled using a defined stylesheet.
report(Writer, IReportable, InputStream, ReportConfiguration) - Static method in class org.apache.rat.Report
Output a report that is styled using a defined stylesheet.
report(IReportable, Writer, ReportConfiguration) - Static method in class org.apache.rat.Report
 
ReportConfiguration - Class in org.apache.rat
A configuration object is used by the frontend to invoke the Report.
ReportConfiguration() - Constructor for class org.apache.rat.ReportConfiguration
 
ReportFormat - Enum in org.apache.rat.config
 
reportLicenseApprovalClaim(Document, boolean) - Method in class org.apache.rat.policy.DefaultPolicy
 
reportOnLicense(Document) - Method in class org.apache.rat.analysis.license.BaseLicense
 
reset() - Method in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired
 
reset() - Method in class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired
 
reset() - Method in interface org.apache.rat.analysis.IHeaderMatcher
Resets this matches.
reset() - Method in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20
 
reset() - Method in class org.apache.rat.analysis.license.CDDL1License
 
reset() - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
reset() - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense
 
reset() - Method in class org.apache.rat.analysis.license.OASISLicense
 
reset() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
reset() - Method in class org.apache.rat.analysis.util.HeaderMatcherMultiplexer
 
run(RatReport) - Method in interface org.apache.rat.report.IReportable
 
run(RatReport) - Method in class org.apache.rat.walker.ArchiveWalker
Run a report over all files and directories in this GZIPWalker, ignoring any files/directories set to be ignored.
run(RatReport) - Method in class org.apache.rat.walker.DirectoryWalker
Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.

S

set(MetaData.Datum) - Method in class org.apache.rat.api.MetaData
Puts in a new datum replacing any existing data.
setAddingLicenses(boolean) - Method in class org.apache.rat.ReportConfiguration
Returns, whether Rat should add missing license headers.
setAddingLicensesForced(boolean) - Method in class org.apache.rat.ReportConfiguration
If Rat is adding license headers: Sets, whether adding license headers is enforced.
setApproveDefaultLicenses(boolean) - Method in class org.apache.rat.ReportConfiguration
 
setApprovedLicenseNames(ILicenseFamily[]) - Method in class org.apache.rat.ReportConfiguration
Sets the set of approved license names.
setApprovedLicenseNames(List<ILicenseFamily>) - Method in class org.apache.rat.ReportConfiguration
Sets the set of approved license names (convenience).
setContentType(ContentType) - Method in class org.apache.rat.api.MetaData
Sets the content type for this subject.
setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration
If Rat is adding license headers: Sets the optional copyright message.
setCopyrightOwner(String) - Method in class org.apache.rat.analysis.license.CopyrightHeader
 
setDocumentCategoryMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets a map with the file types.
setFamilyName(String) - Method in class org.apache.rat.license.SimpleLicenseFamily
 
setForce(boolean) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Set the force flag on this appender.
setFullText(String) - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense
 
setHeaderMatcher(IHeaderMatcher) - Method in class org.apache.rat.ReportConfiguration
Sets the header matcher.
setHeaderPattern(Pattern) - Method in class org.apache.rat.header.HeaderBean
Sets the header pattern to be matched.
setInputFileFilter(FilenameFilter) - Method in class org.apache.rat.Report
Sets the current filter used to select files.
setLicenseFamilyCategory(String) - Method in class org.apache.rat.analysis.license.BaseLicense
 
setLicenseFamilyName(String) - Method in class org.apache.rat.analysis.license.BaseLicense
 
setLicenseFileCodeMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets a map with the license family codes.
setLicenseFileNameMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets map with the license family codes.
setMatch(boolean) - Method in class org.apache.rat.header.HeaderBean
 
setNotes(String) - Method in class org.apache.rat.analysis.license.BaseLicense
 
setNumApproved(int) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets the number of files with approved licenses.
setNumGenerated(int) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets the number of generated files.
setNumUnApproved(int) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets the number of files with unapproved licenses.
setNumUnknown(int) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets the number of files, which are neither generated nor have a known license header.
setPatterns(String[]) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
SimpleLicenseFamily - Class in org.apache.rat.license
Trivial bean implementing ILicenseFamily
SimpleLicenseFamily(String) - Constructor for class org.apache.rat.license.SimpleLicenseFamily
 
SimpleLicenseFamily() - Constructor for class org.apache.rat.license.SimpleLicenseFamily
 
SimplePatternBasedLicense - Class in org.apache.rat.analysis.license
 
SimplePatternBasedLicense() - Constructor for class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
SimplePatternBasedLicense(MetaData.Datum, MetaData.Datum, String, String[]) - Constructor for class org.apache.rat.analysis.license.SimplePatternBasedLicense
 
SimpleXmlClaimReporter - Class in org.apache.rat.report.claim.impl.xml
 
SimpleXmlClaimReporter(IXmlWriter) - Constructor for class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
SourceCodeManagementSystems - Enum in org.apache.rat.config
 
startDocument() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
Starts a document by writing a prolog.
startDocument() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter
Starts a document by writing a prolog.
startReport() - Method in class org.apache.rat.report.AbstractReport
 
startReport() - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
startReport() - Method in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer
 
startReport() - Method in interface org.apache.rat.report.RatReport
 
styleReport(PrintStream) - Method in class org.apache.rat.Report
styleReport(PrintStream, ReportConfiguration) - Method in class org.apache.rat.Report
Output a report in the default style and default license header matcher.

T

TIMESTAMP - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
TMF854LicenseHeader - Class in org.apache.rat.analysis.license
 
TMF854LicenseHeader() - Constructor for class org.apache.rat.analysis.license.TMF854LicenseHeader
 
toName(File) - Static method in class org.apache.rat.document.impl.DocumentImplUtils
 
toNames(ILicenseFamily[]) - Static method in class org.apache.rat.config.ConfigurationUtil
Extract license names from the given license families.
ToNameTransformer - Class in org.apache.rat.document
 
ToNameTransformer() - Constructor for class org.apache.rat.document.ToNameTransformer
 
toNameTransformer() - Static method in class org.apache.rat.document.ToNameTransformer
 
toString() - Method in class org.apache.rat.api.MetaData.Datum
Constructs a String with all attributes in name = value format.
toString() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
Representations suitable for logging.
toString() - Method in class org.apache.rat.document.impl.FileDocument
Representations suitable for logging.
TOTAL_READ_RATIO - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
transform(Object) - Method in class org.apache.rat.document.ToNameTransformer
 
type(InputStream, String) - Method in interface org.apache.rat.api.MimeTyper
Guesses the mime type for the given content.

U

UNAPPROVED_LICENSES_STYLESHEET - Static variable in class org.apache.rat.Defaults
 
UnsuitableDocumentException - Exception in org.apache.rat.document
Indicates that the document was unsuitable for analysis.
UnsuitableDocumentException() - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 
UnsuitableDocumentException(String, Throwable) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 
UnsuitableDocumentException(String) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 
UnsuitableDocumentException(Throwable) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 

V

value(String) - Method in class org.apache.rat.api.MetaData
Gets the value of the first datum matching the given name.
valueOf(String) - Static method in enum org.apache.rat.config.AddLicenseHeaders
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.config.ReportFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.config.SourceCodeManagementSystems
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.rat.config.AddLicenseHeaders
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.config.ReportFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.config.SourceCodeManagementSystems
Returns an array containing the constants of this enum type, in the order they are declared.

W

W3CDocLicense - Class in org.apache.rat.analysis.license
 
W3CDocLicense() - Constructor for class org.apache.rat.analysis.license.W3CDocLicense
 
W3CDocumentLicenseFamily - Class in org.apache.rat.license
 
W3CDocumentLicenseFamily() - Constructor for class org.apache.rat.license.W3CDocumentLicenseFamily
 
W3CLicense - Class in org.apache.rat.analysis.license
 
W3CLicense() - Constructor for class org.apache.rat.analysis.license.W3CLicense
 
W3CSoftwareLicenseFamily - Class in org.apache.rat.license
 
W3CSoftwareLicenseFamily() - Constructor for class org.apache.rat.license.W3CSoftwareLicenseFamily
 
Walker - Class in org.apache.rat.walker
Abstract walker.
Walker(File, FilenameFilter) - Constructor for class org.apache.rat.walker.Walker
 
Walker(String, File, FilenameFilter) - Constructor for class org.apache.rat.walker.Walker
 
writeAttribute(IXmlWriter, String, boolean) - Static method in class org.apache.rat.report.xml.writer.XmlWriterUtils
 
writeClaim(String, String, boolean) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
Writes a single claim to the XML file.

X

XmlReportFactory - Class in org.apache.rat.report.xml
Creates reports.
XmlReportFactory() - Constructor for class org.apache.rat.report.xml.XmlReportFactory
 
XmlWriter - Class in org.apache.rat.report.xml.writer.impl.base
Lightweight IXmlWriter implementation.
XmlWriter(Writer) - Constructor for class org.apache.rat.report.xml.writer.impl.base.XmlWriter
 
XmlWriterUtils - Class in org.apache.rat.report.xml.writer
 
XmlWriterUtils() - Constructor for class org.apache.rat.report.xml.writer.XmlWriterUtils
 
A B C D E F G H I J L M N O P R S T U V W X 
Skip navigation links

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.