Index

A B C D E F G H I J L M N O P R S T U V W X 
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form

A

AbstractBuilder - Class in org.apache.rat.configuration.builders
An abstract IHeaderMatcher.Builder.
AbstractBuilder() - Constructor for class org.apache.rat.configuration.builders.AbstractBuilder
Protected empty constructor.
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
 
AbstractHeaderMatcher - Class in org.apache.rat.analysis.matchers
An abstract class to simplify IHeaderMatcher creation.
AbstractHeaderMatcher(String) - Constructor for class org.apache.rat.analysis.matchers.AbstractHeaderMatcher
Constructs the IHeaderMatcher with an id value.
AbstractLicenseAppender - Class in org.apache.rat.annotation
Add a license header to a document.
AbstractLicenseAppender(Log) - Constructor for class org.apache.rat.annotation.AbstractLicenseAppender
Constructor
AbstractMatcherContainer - Class in org.apache.rat.analysis.matchers
A class that implements IHeaderMatcher as a collection of other IHeaderMatchers.
AbstractMatcherContainer(String, Collection<? extends IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.matchers.AbstractMatcherContainer
Constructs the abstract matcher container.
AbstractMatcherContainer(Collection<? extends IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.matchers.AbstractMatcherContainer
Constructs the abstract matcher container with a unique random id.
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
 
AbstractSimpleMatcher - Class in org.apache.rat.analysis.matchers
An abstract IHeaderMatcher that does simple matching.
AbstractSimpleMatcher(String) - Constructor for class org.apache.rat.analysis.matchers.AbstractSimpleMatcher
Constructs the AbstractSimpleMatcher with the specified id.
accept(File) - Method in class org.apache.rat.walker.NameBasedHiddenFileFilter
Checks to see if the file is hidden, e.g. file name starts with .
add(File) - Method in class org.apache.rat.Defaults.Builder
Adds a configuration file to be read.
add(String) - Method in class org.apache.rat.Defaults.Builder
Adds the name of a configuration file to be read.
add(URL) - Method in class org.apache.rat.Defaults.Builder
Adds a URL to a configuration file to be read.
add(Collection<IHeaderMatcher.Builder>) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
Adds a collection of builders to the list of child builders.
add(IHeaderMatcher.Builder) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
Adds a builder to the list of builders.
add(MetaData.Datum) - Method in class org.apache.rat.api.MetaData
Adds a new datum.
add(ILicenseFamily) - Method in class org.apache.rat.policy.DefaultPolicy
adds an ILicenseFamily to the list of approved licenses.
add(Document) - Method in class org.apache.rat.configuration.XMLConfigurationReader
Merge the new document into the document that this reader processes.
add(T) - Method in class org.apache.rat.utils.ReportingSet
 
addAll(Collection<? extends T>) - Method in class org.apache.rat.utils.ReportingSet
 
addAllIfNotPresent(Collection<? extends T>) - Method in class org.apache.rat.utils.ReportingSet
 
addApprovedLicenseCategories(Collection<String>) - Method in class org.apache.rat.ReportConfiguration
Adds a collection of license family categories to the set of approved license names.
addApprovedLicenseCategory(String) - Method in class org.apache.rat.ReportConfiguration
Adds a license family category (id) to the list of approved licenses
addApprovedLicenseCategory(ILicenseFamily) - Method in class org.apache.rat.ReportConfiguration
Adds an ILicenseFamily to the list of approved licenses.
addBuilder(String, String) - Static method in class org.apache.rat.configuration.MatcherBuilderTracker
Adds a builder to the tracker.
addDirectoryFilter(IOFileFilter) - Method in class org.apache.rat.ReportConfiguration
 
addFamilies(Collection<ILicenseFamily>) - Method in class org.apache.rat.ReportConfiguration
Adds multiple families to the list of license families.
addFamily(ILicenseFamily) - Method in class org.apache.rat.ReportConfiguration
Adds a license family to the list of families.
addFamily(ILicenseFamily.Builder) - Method in class org.apache.rat.ReportConfiguration
Adds a license family to the list of families.
addIfNotPresent(T) - Method in class org.apache.rat.utils.ReportingSet
Adds the item if it is not present.
addLicense(ILicense) - Method in class org.apache.rat.ReportConfiguration
Adds a license to the list of licenses.
addLicense(ILicense.Builder) - Method in class org.apache.rat.ReportConfiguration
Adds a license to the list of licenses.
AddLicenseHeaders - Enum in org.apache.rat.config
Value of addLicenseHeaders configuration option.
addLicenses(URL) - Method in interface org.apache.rat.configuration.LicenseReader
Adds a URL to the set of files to be read.
addLicenses(URL) - Method in class org.apache.rat.configuration.XMLConfigurationReader
 
addLicenses(Collection<ILicense>) - Method in class org.apache.rat.ReportConfiguration
Adds multiple licenses to the list of licenses.
addLicensesIfNotPresent(Collection<ILicense>) - Method in class org.apache.rat.ReportConfiguration
Adds multiple licenses to the list of licenses.
addMatchers(URL) - Method in interface org.apache.rat.configuration.MatcherReader
Adds a URL to the set of files to be read.
addMatchers(URL) - Method in class org.apache.rat.configuration.XMLConfigurationReader
 
all - Enum constant in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter
All defined licenses are returned
all() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
AllBuilder - Class in org.apache.rat.configuration.builders
Constructs a All matcher.
AllBuilder() - Constructor for class org.apache.rat.configuration.builders.AllBuilder
 
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
 
AndMatcher - Class in org.apache.rat.analysis.matchers
A matcher that performs a logical AND across all the contained matchers.
AndMatcher(String, Collection<? extends IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.matchers.AndMatcher
Constructs the AndMatcher with the specified id and enclosed collection.
AndMatcher(Collection<? extends IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.matchers.AndMatcher
Constructs the AndMatcher with the a unique random id and the enclosed collection.
any() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
AnyBuilder - Class in org.apache.rat.configuration.builders
Constructs an Any matcher.
AnyBuilder() - Constructor for class org.apache.rat.configuration.builders.AnyBuilder
 
ApacheV2LicenseAppender - Class in org.apache.rat.annotation
Add an Apache License V2 license header to a document.
ApacheV2LicenseAppender(Log) - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender
Create a license appender with the standard ASF license header.
ApacheV2LicenseAppender(Log, 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.
approved - Enum constant in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter
Only approved licenses are returned
approvedLicenseId() - Method in interface org.apache.rat.configuration.LicenseReader
Reads the configuration and extracts the list of approved licenses.
approvedLicenseId() - Method in class org.apache.rat.configuration.XMLConfigurationReader
 
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.
asBoolean() - Method in enum org.apache.rat.analysis.IHeaderMatcher.State
 
ASCII_CHAR_THRESHOLD - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
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
Deprecated.
BaseLicense() - Constructor for class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
BAZAAR - Enum constant in enum org.apache.rat.config.SourceCodeManagementSystems
 
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
 
build() - Method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
Build the IHeaderMatcher.
build() - Method in class org.apache.rat.configuration.builders.AllBuilder
 
build() - Method in class org.apache.rat.configuration.builders.AnyBuilder
 
build() - Method in class org.apache.rat.configuration.builders.CopyrightBuilder
 
build() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder
 
build() - Method in class org.apache.rat.configuration.builders.NotBuilder
 
build() - Method in class org.apache.rat.configuration.builders.RegexBuilder
 
build() - Method in class org.apache.rat.configuration.builders.SpdxBuilder
 
build() - Method in class org.apache.rat.configuration.builders.TextBuilder
 
build() - Method in class org.apache.rat.Defaults.Builder
Builds the defaults object.
build() - Method in interface org.apache.rat.license.ILicenseFamily.Builder
 
build() - Method in class org.apache.rat.license.ILicenseFamilyBuilder
 
build(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.license.ILicense.Builder
 
builder() - Static method in class org.apache.rat.Defaults
Gets a builder for a Defaults object.
builder() - Static method in interface org.apache.rat.license.ILicense
 
builder() - Static method in interface org.apache.rat.license.ILicenseFamily
 
Builder() - Constructor for class org.apache.rat.license.ILicense.Builder
 

C

ChildContainerBuilder - Class in org.apache.rat.configuration.builders
Constructs a builder that contains other builders.
ChildContainerBuilder() - Constructor for class org.apache.rat.configuration.builders.ChildContainerBuilder
Empty default constructor.
children - Variable in class org.apache.rat.configuration.builders.ChildContainerBuilder
The list of builders that will build the enclosed matchers.
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() - Method in class org.apache.rat.api.MetaData
Clears all data.
clear() - Method in class org.apache.rat.utils.ReportingSet
 
clear(String) - Method in class org.apache.rat.api.MetaData
Removes all data matching the given name.
close() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
 
close() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
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() - Method in class org.apache.rat.utils.ReportingSet
 
compareTo(ILicense) - Method in class org.apache.rat.analysis.UnknownLicense
 
compareTo(ILicenseFamily) - Method in interface org.apache.rat.license.ILicenseFamily
 
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
 
ConfigurationException - Exception in org.apache.rat
An exception thrown when there is an issue with the Configuration.
ConfigurationException(String) - Constructor for exception org.apache.rat.ConfigurationException
 
ConfigurationException(String, Throwable) - Constructor for exception org.apache.rat.ConfigurationException
 
ConfigurationException(Throwable) - Constructor for exception org.apache.rat.ConfigurationException
 
contains(Object) - Method in class org.apache.rat.utils.ReportingSet
 
containsAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
 
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 any necessary conversions.
copyright() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
CopyrightBuilder - Class in org.apache.rat.configuration.builders
A copyright builder.
CopyrightBuilder() - Constructor for class org.apache.rat.configuration.builders.CopyrightBuilder
 
CopyrightMatcher - Class in org.apache.rat.analysis.matchers
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.
CopyrightMatcher(String, String, String) - Constructor for class org.apache.rat.analysis.matchers.CopyrightMatcher
Constructs the CopyrightMatcher with the specified start, stop and owner strings and a unique random id..
CopyrightMatcher(String, String, String, String) - Constructor for class org.apache.rat.analysis.matchers.CopyrightMatcher
Constructs the CopyrightMatcher with the specified start, stop and owner strings.
create(String) - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory
Creates the spdx matcher.
createDefaultAnalyser(Log, Collection<ILicense>) - Static method in class org.apache.rat.analysis.DefaultAnalyserFactory
Creates a DocumentAnalyser from a collection of ILicenses.
createStandardReport(IXmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory
Creates a RatReport from the arguments.
createTextMatcher(String, String) - Static method in class org.apache.rat.configuration.XMLConfigurationReader
Create a text matcher.
currentState() - Method in interface org.apache.rat.analysis.IHeaderMatcher
Gets the the current state of the matcher.
currentState() - Method in class org.apache.rat.analysis.matchers.AbstractSimpleMatcher
 
currentState() - Method in class org.apache.rat.analysis.matchers.AndMatcher
 
currentState() - Method in class org.apache.rat.analysis.matchers.NotMatcher
 
currentState() - Method in class org.apache.rat.analysis.matchers.OrMatcher
 
currentState() - Method in class org.apache.rat.analysis.UnknownLicense
 
CVS - Enum constant in enum org.apache.rat.config.SourceCodeManagementSystems
 

D

Datum(String, String) - Constructor for class org.apache.rat.api.MetaData.Datum
Constructs a datum.
debug(Object) - Method in interface org.apache.rat.utils.Log
 
DEBUG - Enum constant in enum org.apache.rat.utils.Log.Level
Log debug only.
DefaultAnalyserFactory - Class in org.apache.rat.analysis
Creates default analysers.
DefaultAnalyserFactory() - Constructor for class org.apache.rat.analysis.DefaultAnalyserFactory
 
DefaultLog - Class in org.apache.rat.utils
A default implementation of Log that writes to System.out and System.err
DefaultPolicy - Class in org.apache.rat.policy
A default Document Analyser that determines if the matched license is in the set of approved licenses.
DefaultPolicy(Collection<ILicenseFamily>) - Constructor for class org.apache.rat.policy.DefaultPolicy
Constructor with the list of approved license families.
Defaults - Class in org.apache.rat
A class that holds the list of licenses and approved licenses from one or more configuration files.
Defaults.Builder - Class in org.apache.rat
The Defaults builder.
DeprecatedConfig - Interface in org.apache.rat.analysis.license
Deprecated.
derivedFrom() - Method in class org.apache.rat.analysis.UnknownLicense
 
derivedFrom() - Method in interface org.apache.rat.license.ILicense
 
DirectoryWalker - Class in org.apache.rat.walker
Walks directories.
DirectoryWalker(File, FilenameFilter, IOFileFilter) - Constructor for class org.apache.rat.walker.DirectoryWalker
Constructs a walker.
DirectoryWalker(File, Pattern, IOFileFilter) - Constructor for class org.apache.rat.walker.DirectoryWalker
Constructs a walker.
DirectoryWalker(File, IOFileFilter) - Constructor for class org.apache.rat.walker.DirectoryWalker
Constructs a walker.
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
 
DocumentImplUtils - Class in org.apache.rat.document.impl
 
DocumentImplUtils() - Constructor for class org.apache.rat.document.impl.DocumentImplUtils
 
doMatch(String) - Method in class org.apache.rat.analysis.matchers.AbstractSimpleMatcher
Performs the actual match test.
doMatch(String) - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher
 
doMatch(String) - Method in class org.apache.rat.analysis.matchers.FullTextMatcher
 
doMatch(String) - Method in class org.apache.rat.analysis.matchers.SimpleRegexMatcher
 
doMatch(String) - Method in class org.apache.rat.analysis.matchers.SimpleTextMatcher
 
doMatch(String) - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match
 

E

emptyLicenseFamilySet() - Static method in class org.apache.rat.license.LicenseFamilySetFactory
Create an empty sorted Set with proper comparator.
emptyLicenseSet() - Static method in class org.apache.rat.license.LicenseSetFactory
Create an empty sorted Set with proper comparator.
enclosed - Variable in class org.apache.rat.analysis.matchers.AbstractMatcherContainer
 
endReport() - Method in class org.apache.rat.report.AbstractReport
Empty default implementation.
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
Signals the end of execution for the report.
equals(Object) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
equals(Object) - Method in class org.apache.rat.utils.ReportingSet
 
error(Object) - Method in interface org.apache.rat.utils.Log
 
ERROR - Enum constant in enum org.apache.rat.utils.Log.Level
Log error only.
extensionMatches(String, String[]) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser
 

F

f - Enum constant in enum org.apache.rat.analysis.IHeaderMatcher.State
 
FAIL - Enum constant in enum org.apache.rat.utils.ReportingSet.Options
 
FALSE - Enum constant in enum org.apache.rat.config.AddLicenseHeaders
 
familyDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.ReportConfiguration
Sets the reporting option for duplicate license families.
file - Variable in class org.apache.rat.walker.Walker
 
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
 
finalizeState() - Method in interface org.apache.rat.analysis.IHeaderMatcher
Gets the final state for this matcher.
finalizeState() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer
 
finalizeState() - Method in class org.apache.rat.analysis.matchers.AbstractSimpleMatcher
 
finalizeState() - Method in class org.apache.rat.analysis.matchers.AndMatcher
 
finalizeState() - Method in class org.apache.rat.analysis.matchers.NotMatcher
 
finalizeState() - Method in class org.apache.rat.analysis.UnknownLicense
 
first() - Method in class org.apache.rat.utils.ReportingSet
 
flush() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
FORCED - Enum constant in enum org.apache.rat.config.AddLicenseHeaders
 
forEach(Consumer<? super T>) - Method in class org.apache.rat.utils.ReportingSet
 
Format - Enum in org.apache.rat.configuration
An enumeration of the types of files that can contain the configuration information.
fromFile(File) - Static method in enum org.apache.rat.configuration.Format
Determine the Format from a File.
fromName(String) - Static method in enum org.apache.rat.configuration.Format
Determine the Format from the file name.
fromText(String) - Static method in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter
Converts from a String to an enum value.
fromURL(URL) - Static method in enum org.apache.rat.configuration.Format
Determine the Format from a URL.
FullTextMatcher - Class in org.apache.rat.analysis.matchers
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).
FullTextMatcher(String) - Constructor for class org.apache.rat.analysis.matchers.FullTextMatcher
Constructs the full text matcher with a unique random id and the specified text to match.
FullTextMatcher(String, String) - Constructor for class org.apache.rat.analysis.matchers.FullTextMatcher
Constructs the full text matcher for the specified text.
FullTextMatchingLicense - Class in org.apache.rat.analysis.license
Deprecated.
Use new configuration options
FullTextMatchingLicense() - Constructor for class org.apache.rat.analysis.license.FullTextMatchingLicense
Deprecated.
 

G

get(String) - Method in class org.apache.rat.api.MetaData
Gets the first datum matching the given name.
getApprovedLicenseCategories() - Method in class org.apache.rat.ReportConfiguration
Gets the SortedSet of approved license categories.
getApprovedLicenseNames() - Method in class org.apache.rat.policy.DefaultPolicy
Gets an unmodifiable reference to the SortedSet of approved licenses that this policy is holding.
getCategory() - Method in interface org.apache.rat.license.ILicenseFamily.Builder
Gets the category that this builder is building.
getCategory() - Method in class org.apache.rat.license.ILicenseFamilyBuilder
 
getChildren() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
 
getComparator() - Static method in interface org.apache.rat.license.ILicense
 
getCopyrightMessage() - Method in class org.apache.rat.ReportConfiguration
Returns the optional license copyright being added if RAT is adding headers.
getData() - Method in class org.apache.rat.api.MetaData
Gets all data.
getDirectoryFilter() - Method in class org.apache.rat.ReportConfiguration
 
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
getFamilies(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseFamilySetFactory
Gets the License objects based on the filter.
getFamilyCategory() - Method in interface org.apache.rat.license.ILicenseFamily
 
getFamilyCategory() - Method in class org.apache.rat.license.SimpleLicenseFamily
Deprecated.
 
getFamilyIds(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseFamilySetFactory
Gets the categories of LicenseFamily objects based on the filter.
getFamilyName() - Method in interface org.apache.rat.license.ILicenseFamily
 
getFamilyName() - Method in class org.apache.rat.license.SimpleLicenseFamily
Deprecated.
 
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.
getHeaderPattern() - Method in class org.apache.rat.header.HeaderBean
Gets the header pattern to be matched.
getId() - Method in interface org.apache.rat.analysis.IHeaderMatcher
Get the identifier for this matcher.
getId() - Method in class org.apache.rat.analysis.matchers.AbstractHeaderMatcher
 
getId() - Method in class org.apache.rat.analysis.UnknownLicense
 
getId() - Method in class org.apache.rat.configuration.builders.AbstractBuilder
 
getIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems
Maybe null, check before with
getInputFileFilter() - Method in class org.apache.rat.ReportConfiguration
 
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.
getLevel() - Method in class org.apache.rat.utils.DefaultLog
 
getLicense() - Method in interface org.apache.rat.analysis.license.DeprecatedConfig
Deprecated.
 
getLicense() - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense
Deprecated.
 
getLicense() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
Deprecated.
 
getLicenseFamilies(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.Defaults
Gets the sorted set of approved licenses for a given filter condition.
getLicenseFamilies(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseSetFactory
Gets the LicenseFamily objects based on the filter.
getLicenseFamilies(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration
Gets a sorted set of ILicenseFamily objects based on filter. if filter is set: all - All licenses families will be returned. approved - Only approved license families will be returned none - No license families will be returned
getLicenseFamily() - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
getLicenseFamily() - Method in interface org.apache.rat.analysis.license.DeprecatedConfig
Deprecated.
 
getLicenseFamily() - Method in class org.apache.rat.analysis.UnknownLicense
 
getLicenseFamily() - Method in interface org.apache.rat.license.ILicense
 
getLicenseFamilyCategory() - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
getLicenseFamilyIds(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseSetFactory
Gets the categories of LicenseFamily objects based on the filter.
getLicenseFamilyName() - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
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
 
getLicenseIds(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.Defaults
Gets the sorted set of approved license ids for a given filter condition.
getLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.Defaults
Gets the sorted set of approved licenses for a given filter condition.
getLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseSetFactory
Gets the License objects based on the filter.
getLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration
Gets a set Licenses of depending on the filter if filter is set: all - All licenses will be returned. approved - Only approved licenses will be returned none - No licenses will be returned
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.
getLineNumber() - Method in class org.apache.rat.header.LineNumberReader
 
getLog() - Method in class org.apache.rat.ReportConfiguration
Retrieves the Log that was provided in the constructor.
getMatcherBuilder(String) - Static method in class org.apache.rat.configuration.MatcherBuilderTracker
Get the matching builder for the name.
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 class org.apache.rat.analysis.UnknownLicense
 
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
 
getName() - Method in interface org.apache.rat.license.ILicense
Returns the name of this license.
getNotes() - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
getNotes() - Method in class org.apache.rat.analysis.UnknownLicense
 
getNotes() - Method in interface org.apache.rat.license.ILicense
 
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
 
getOutput() - Method in class org.apache.rat.ReportConfiguration
Returns the output stream supplier.
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
Deprecated.
 
getPlainStyleSheet() - Static method in class org.apache.rat.Defaults
Gets a supplier for the "plain" text stylesheet.
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.
getReportable() - Method in class org.apache.rat.ReportConfiguration
 
getStyleSheet() - Method in class org.apache.rat.ReportConfiguration
 
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
Gets a supplier for the unapproved licences list stylesheet
getValue() - Method in class org.apache.rat.api.MetaData.Datum
Data type value.
getValuesForHelp() - Static method in enum org.apache.rat.config.AddLicenseHeaders
 
getWriter() - Method in class org.apache.rat.ReportConfiguration
 
GIT - Enum constant in enum org.apache.rat.config.SourceCodeManagementSystems
 
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
Empty default implementation.
handleApprovedLicenseClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
handleDocumentCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
Empty default implementation.
handleDocumentCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
handleHeaderCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
Empty default implementation.
handleHeaderCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
handleLicenseFamilyNameClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter
Empty default implementation.
handleLicenseFamilyNameClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
 
hashCode() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
hashCode() - Method in class org.apache.rat.utils.ReportingSet
 
hasId() - Method in class org.apache.rat.configuration.builders.AbstractBuilder
 
hasIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems
 
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
 
headSet(T) - Method in class org.apache.rat.utils.ReportingSet
 
HIDDEN - Static variable in class org.apache.rat.walker.NameBasedHiddenFileFilter
Singleton instance of hidden filter.
HIGH_BYTES_RATIO - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 

I

i - Enum constant in enum org.apache.rat.analysis.IHeaderMatcher.State
 
IDocumentAnalyser - Interface in org.apache.rat.document
 
IGNORE - Enum constant in enum org.apache.rat.utils.ReportingSet.Options
 
IHeaderMatcher - Interface in org.apache.rat.analysis
Performs explicit checks against a line from the header of a file.
IHeaderMatcher.Builder - Interface in org.apache.rat.analysis
An IHeaderMatcher builder.
IHeaderMatcher.State - Enum in org.apache.rat.analysis
The state of the matcher.
ILicense - Interface in org.apache.rat.license
The definition of a License.
ILicense.Builder - Class in org.apache.rat.license
A builder for ILicense instances.
ILicenseFamily - Interface in org.apache.rat.license
The definition of the license family.
ILicenseFamily.Builder - Interface in org.apache.rat.license
The definition of an ILicenseFamily builder.
ILicenseFamilyBuilder - Class in org.apache.rat.license
An instance of the ILicenseFamily Builder.
ILicenseFamilyBuilder() - Constructor for class org.apache.rat.license.ILicenseFamilyBuilder
 
info(Object) - Method in interface org.apache.rat.utils.Log
 
INFO - Enum constant in enum org.apache.rat.utils.Log.Level
Log info only.
init() - Static method in class org.apache.rat.Defaults
Initialize the system configuration reader..
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
 
INSTANCE - Static variable in class org.apache.rat.analysis.matchers.SPDXMatcherFactory
The instance of this factory.
INSTANCE - Static variable in class org.apache.rat.utils.DefaultLog
The instance of the default log.
InvalidXmlException - Exception in org.apache.rat.report.xml.writer
Indicates that the requested document is not well formed.
InvalidXmlException(String) - Constructor for exception org.apache.rat.report.xml.writer.InvalidXmlException
Instantiate exception with given message.
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
This value is ignored if RAT is not adding licenses.
isArchive(String) - Static method in class org.apache.rat.document.impl.guesser.ArchiveGuesser
 
isArchive(Document) - Static method in class org.apache.rat.document.impl.guesser.ArchiveGuesser
 
isAudio(String) - 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(Reader) - 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
 
isEmpty() - Method in class org.apache.rat.utils.ReportingSet
 
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
 
isNotIgnored(File) - Method in class org.apache.rat.walker.Walker
 
isStyleReport() - Method in class org.apache.rat.ReportConfiguration
 
isZip(File) - Static method in class org.apache.rat.document.impl.DocumentImplUtils
 
isZipStream(InputStream) - Static method in class org.apache.rat.document.impl.DocumentImplUtils
 
iterator() - Method in class org.apache.rat.utils.ReportingSet
 
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
 

L

last() - Method in class org.apache.rat.utils.ReportingSet
 
LicenseAddingReport - Class in org.apache.rat.report.claim.util
 
LicenseAddingReport(Log, String, boolean) - Constructor for class org.apache.rat.report.claim.util.LicenseAddingReport
 
licenseDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.ReportConfiguration
Sets the reporting option for duplicate licenses.
LicenseFamilySetFactory - Class in org.apache.rat.license
Class to take a set of ILicenses and collection of approved license categories and extract Subsets.
LicenseFamilySetFactory(SortedSet<ILicenseFamily>, Collection<String>) - Constructor for class org.apache.rat.license.LicenseFamilySetFactory
Constructs a factory with the specified set of Licenses and the approved license collection.
licenseReader() - Method in enum org.apache.rat.configuration.Format
 
LicenseReader - Interface in org.apache.rat.configuration
An interface describing the methods of a LicenseReader.
LicenseSetFactory - Class in org.apache.rat.license
Class to take a set of ILicenses and collection of approved license categories and extract Subsets.
LicenseSetFactory(SortedSet<ILicense>, Collection<String>) - Constructor for class org.apache.rat.license.LicenseSetFactory
Constructs a factory with the specified set of Licenses and the approved license collection.
LicenseSetFactory.LicenseFilter - Enum in org.apache.rat.license
An enum that defines the types of Licenses to extract.
LineNumberReader - Class in org.apache.rat.header
Replacement for LineNumberReader.
LineNumberReader(Reader) - Constructor for class org.apache.rat.header.LineNumberReader
 
lines() - Method in class org.apache.rat.header.HeaderMatcher
Number of lines read.
listLicenseFamilies(ReportConfiguration, LicenseSetFactory.LicenseFilter) - Static method in class org.apache.rat.Reporter
lists the license families information on the configured output stream.
listLicenses(ReportConfiguration, LicenseSetFactory.LicenseFilter) - Static method in class org.apache.rat.Reporter
lists the licenses on the configured output stream.
log(Log.Level, Object) - Method in interface org.apache.rat.utils.Log
 
log(Log.Level, String) - Method in class org.apache.rat.utils.DefaultLog
 
log(Log.Level, String) - Method in interface org.apache.rat.utils.Log
Writes a message at a specific log level.
Log - Interface in org.apache.rat.utils
The definition of logging for the core.
Log.Level - Enum in org.apache.rat.utils
The log levels supported by logging.
logFamilyCollisions(Log.Level) - Method in class org.apache.rat.ReportConfiguration
Set the log level for reporting collisions in the set of license families.
logLicenseCollisions(Log.Level) - Method in class org.apache.rat.ReportConfiguration
Sets the log level for reporting license collisions.

M

main(String[]) - Static method in class org.apache.rat.Report
Processes the command line and builds a configuration and executes the report.
makeCategory(String) - Static method in interface org.apache.rat.license.ILicenseFamily
Convert a potential category string into a category string of exactly 5 characters either by truncating the string or appending spaces as necessary.
MatcherBuilderTracker - Class in org.apache.rat.configuration
A class to track the Matcher Builders as they are defined.
matcherReader() - Method in enum org.apache.rat.configuration.Format
 
MatcherReader - Interface in org.apache.rat.configuration
An interface that describes the methods of a Matcher reader.
matcherRef() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
MatcherRefBuilder - Class in org.apache.rat.configuration.builders
A reference matching Matcher builder.
MatcherRefBuilder() - Constructor for class org.apache.rat.configuration.builders.MatcherRefBuilder
 
matches(String) - Method in interface org.apache.rat.analysis.IHeaderMatcher
Attempts to match line and returns the State after the match is attempted.
matches(String) - Method in class org.apache.rat.analysis.matchers.AbstractSimpleMatcher
 
matches(String) - Method in class org.apache.rat.analysis.matchers.AndMatcher
 
matches(String) - Method in class org.apache.rat.analysis.matchers.NotMatcher
 
matches(String) - Method in class org.apache.rat.analysis.matchers.OrMatcher
 
matches(String) - Method in class org.apache.rat.analysis.UnknownLicense
 
matches(Pattern) - Method in class org.apache.rat.header.HeaderMatcher
Seeks a match in the last headers read.
MERCURIAL - Enum constant in enum org.apache.rat.config.SourceCodeManagementSystems
 
MetaData - Class in org.apache.rat.api
Data about the document under test..
MetaData() - Constructor for class org.apache.rat.api.MetaData
Create metadata without a content type.
MetaData.Datum - Class in org.apache.rat.api
A datum.
MimeTyper - Interface in org.apache.rat.api
Discovers the mime type of content.
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
 
NameBasedHiddenFileFilter - Class in org.apache.rat.walker
This filter accepts Files that are hidden, e.g. file name starts with .
NameBasedHiddenFileFilter() - Constructor for class org.apache.rat.walker.NameBasedHiddenFileFilter
Restrictive constructor.
newInstance(URL) - Static method in class org.apache.rat.document.impl.MonolithicFileDocument
 
NoCloseOutputStream(OutputStream) - Constructor for class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
noDefault() - Method in class org.apache.rat.Defaults.Builder
Removes the default definitions from the list of files to process.
NON_ASCII_THRESHOLD - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
none - Enum constant in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter
No licenses are returned
normalise(String) - Static method in class org.apache.rat.document.impl.guesser.GuessUtils
Converts name to upper case and strips any path.
not() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
NotBuilder - Class in org.apache.rat.configuration.builders
A builder for the NotMatcher.
NotBuilder() - Constructor for class org.apache.rat.configuration.builders.NotBuilder
 
NoteGuesser - Class in org.apache.rat.document.impl.guesser
 
NoteGuesser() - Constructor for class org.apache.rat.document.impl.guesser.NoteGuesser
 
NotMatcher - Class in org.apache.rat.analysis.matchers
An IHeaderMatcher that reverses the result of an enclosed matcher.
NotMatcher(String, IHeaderMatcher) - Constructor for class org.apache.rat.analysis.matchers.NotMatcher
Create the matcher with the enclosed matcher and id.
NotMatcher(IHeaderMatcher) - Constructor for class org.apache.rat.analysis.matchers.NotMatcher
Create the matcher with the enclosed matcher.

O

OFF - Enum constant in enum org.apache.rat.utils.Log.Level
Log nothing.
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.license - package org.apache.rat.analysis.license
 
org.apache.rat.analysis.matchers - package org.apache.rat.analysis.matchers
 
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.configuration - package org.apache.rat.configuration
 
org.apache.rat.configuration.builders - package org.apache.rat.configuration.builders
 
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.utils - package org.apache.rat.utils
 
org.apache.rat.walker - package org.apache.rat.walker
 
OrMatcher - Class in org.apache.rat.analysis.matchers
A matcher that performs a logical OR across all the contained matchers.
OrMatcher(String, Collection<? extends IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.matchers.OrMatcher
Constructs the matcher with the specified id from the enclosed matchers.
OrMatcher(Collection<? extends IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.matchers.OrMatcher
Constructs the matcher from the enclosed matchers.
OVERWRITE - Enum constant in enum org.apache.rat.utils.ReportingSet.Options
 

P

parallelStream() - Method in class org.apache.rat.utils.ReportingSet
 
PLAIN - Enum constant in enum org.apache.rat.config.ReportFormat
 
PLAIN_STYLESHEET - Static variable in class org.apache.rat.Defaults
The default XSLT stylesheet to produce a text output file.
prune(String) - Static method in class org.apache.rat.analysis.matchers.FullTextMatcher
Removes everything except letter or digit from text.

R

RAT_APPROVED_LICENSE_DATIM_FALSE - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_APPROVED_LICENSE_DATIM_TRUE - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_APPROVED_LICENSE_DATUM_FALSE - Static variable in class org.apache.rat.api.MetaData
 
RAT_APPROVED_LICENSE_DATUM_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
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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
Deprecated.
RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_MIT - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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
Deprecated.
RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3 - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_MIT - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE - Static variable in class org.apache.rat.api.MetaData
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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
Deprecated.
RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData
Deprecated.
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(String, Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
 
RatDocumentAnalysisException(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) - Constructor for exception org.apache.rat.api.RatException
 
RatException(String, Throwable) - 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) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
 
RatHeaderAnalysisException(String, Throwable) - 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
Interface that defines a RatReport.
RatReportAnalysisResultException - Exception in org.apache.rat.analysis
 
RatReportAnalysisResultException() - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException
 
RatReportAnalysisResultException(String, RatException) - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException
 
RatReportAnalysisResultException(RatException) - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException
 
read() - Method in class org.apache.rat.header.LineNumberReader
 
read(Reader) - Method in class org.apache.rat.header.HeaderMatcher
 
read(URL...) - Method in class org.apache.rat.configuration.XMLConfigurationReader
Read the urls and create a single document to process.
reader() - Method in interface org.apache.rat.api.Document
Reads the contents 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
 
readFamilies() - Method in interface org.apache.rat.configuration.LicenseReader
Reads the configuration and extracts instances of ILicenseFamily.
readFamilies() - Method in class org.apache.rat.configuration.XMLConfigurationReader
 
readLicenses() - Method in interface org.apache.rat.configuration.LicenseReader
Reads the configuration and extracts instances of ILicense.
readLicenses() - Method in class org.apache.rat.configuration.XMLConfigurationReader
 
readMatcherBuilders() - Method in interface org.apache.rat.configuration.MatcherReader
Reads the configuration and MatcherBuilder classes and adds them to Readers.
readMatcherBuilders() - Method in class org.apache.rat.configuration.XMLConfigurationReader
 
regex() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
RegexBuilder - Class in org.apache.rat.configuration.builders
A builder for the regex matcher.
RegexBuilder() - Constructor for class org.apache.rat.configuration.builders.RegexBuilder
 
regexFilter(Pattern) - Static method in class org.apache.rat.walker.Walker
 
remove(File) - Method in class org.apache.rat.Defaults.Builder
Removes a file from the list of configuration files to process.
remove(Object) - Method in class org.apache.rat.utils.ReportingSet
 
remove(String) - Method in class org.apache.rat.Defaults.Builder
Removes a file name from the list of configuration files to process.
remove(URL) - Method in class org.apache.rat.Defaults.Builder
Removes a file from the list of configuration files to process.
removeAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
 
removeApprovedLicenseCategories(Collection<String>) - Method in class org.apache.rat.ReportConfiguration
Removes a license family category from the list of approved licenses.
removeApprovedLicenseCategory(String) - Method in class org.apache.rat.ReportConfiguration
Adds a license family category to the list of approved licenses.
removeIf(Predicate<? super T>) - Method in class org.apache.rat.utils.ReportingSet
 
report(Document) - Method in class org.apache.rat.report.AbstractReport
Empty default implementation.
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
Performs the actual reporting on the given document.
report(ReportConfiguration) - Static method in class org.apache.rat.Reporter
Execute the report.
Report - Class in org.apache.rat
The CLI based configuration object for report generation.
ReportConfiguration - Class in org.apache.rat
A configuration object is used by the front end to invoke the Reporter.
ReportConfiguration(Log) - Constructor for class org.apache.rat.ReportConfiguration
Constructor
ReportConfiguration.NoCloseOutputStream - Class in org.apache.rat
A wrapper around an output stream that does not close the output stream.
Reporter - Class in org.apache.rat
Class that executes the report as defined in a ReportConfiguration.
ReportFormat - Enum in org.apache.rat.config
 
ReportingSet<T> - Class in org.apache.rat.utils
A sorted set that reports insertion collisions.
ReportingSet() - Constructor for class org.apache.rat.utils.ReportingSet
Constructor.
ReportingSet(SortedSet<T>) - Constructor for class org.apache.rat.utils.ReportingSet
Constructs.
ReportingSet.Options - Enum in org.apache.rat.utils
 
reportLicenseApprovalClaim(Document, boolean) - Method in class org.apache.rat.policy.DefaultPolicy
Report if the document as either having approved license or not.
reportOnLicense(ILicense) - Method in class org.apache.rat.api.MetaData
Add the license information to the metadata.
reset() - Method in interface org.apache.rat.analysis.IHeaderMatcher
Resets this state State.i.
reset() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer
 
reset() - Method in class org.apache.rat.analysis.matchers.AbstractSimpleMatcher
 
reset() - Method in class org.apache.rat.analysis.matchers.FullTextMatcher
 
reset() - Method in class org.apache.rat.analysis.matchers.NotMatcher
 
reset() - Method in class org.apache.rat.analysis.matchers.OrMatcher
 
reset() - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match
 
reset() - Method in class org.apache.rat.analysis.UnknownLicense
 
retainAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
 
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

search(String, SortedSet<ILicense>) - Static method in class org.apache.rat.license.LicenseSetFactory
Search a SortedSet of licenses for the matching license id.
search(String, SortedSet<ILicenseFamily>) - Static method in class org.apache.rat.license.LicenseFamilySetFactory
Search a SortedSet of ILicenseFamily instances looking for a matching instance.
search(ILicenseFamily, SortedSet<ILicenseFamily>) - Static method in class org.apache.rat.license.LicenseFamilySetFactory
Search a SortedSet of ILicenseFamily instances looking for a matching instance.
search(ILicense, SortedSet<ILicense>) - Static method in class org.apache.rat.license.LicenseSetFactory
Search a SortedSet of licenses for the matching license.
set(MetaData.Datum) - Method in class org.apache.rat.api.MetaData
Puts in a new datum replacing any existing data.
setAddLicenseHeaders(AddLicenseHeaders) - Method in class org.apache.rat.ReportConfiguration
Sets whether RAT should enable, disable, or force the adding of license headers.
setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration
Sets the optional copyright message used if RAT is adding license headers.
setDerivedFrom(String) - Method in class org.apache.rat.license.ILicense.Builder
Sets the derived from fields in the license.
setDirectoryFilter(IOFileFilter) - Method in class org.apache.rat.ReportConfiguration
 
setDocumentCategoryMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic
Sets a map with the file types.
setDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.utils.ReportingSet
If set true attempts to duplicate will throw an IllegalArgumentException.
setEnd(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder
Sets the end date.
setExpr(String) - Method in class org.apache.rat.configuration.builders.RegexBuilder
Sets the regex expression.
setFamilyCategory(String) - Method in class org.apache.rat.license.SimpleLicenseFamily
Deprecated.
 
setFamilyName(String) - Method in class org.apache.rat.license.SimpleLicenseFamily
Deprecated.
 
setForce(boolean) - Method in class org.apache.rat.annotation.AbstractLicenseAppender
Set the force flag on this appender.
setFrom(Defaults) - Method in class org.apache.rat.ReportConfiguration
Adds the licenses and approved licenses from the defaults object to the configuration.
setFullText(String) - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense
Deprecated.
 
setHeaderPattern(Pattern) - Method in class org.apache.rat.header.HeaderBean
Sets the header pattern to be matched.
setId(String) - Method in class org.apache.rat.configuration.builders.AbstractBuilder
Set the id for the matcher.
setId(String) - Method in class org.apache.rat.license.ILicense.Builder
Sets the ID of the license.
setInputFileFilter(FilenameFilter) - Method in class org.apache.rat.ReportConfiguration
 
setLevel(Log.Level) - Method in class org.apache.rat.utils.DefaultLog
 
setLicenseFamilyCategory(String) - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
setLicenseFamilyCategory(String) - Method in class org.apache.rat.license.ILicense.Builder
Set the family category for this license.
setLicenseFamilyCategory(String) - Method in interface org.apache.rat.license.ILicenseFamily.Builder
Sets the license family category.
setLicenseFamilyCategory(String) - Method in class org.apache.rat.license.ILicenseFamilyBuilder
 
setLicenseFamilyName(String) - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
setLicenseFamilyName(String) - Method in interface org.apache.rat.license.ILicenseFamily.Builder
Sets the license family name.
setLicenseFamilyName(String) - Method in class org.apache.rat.license.ILicenseFamilyBuilder
 
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.
setLog(Log) - Method in class org.apache.rat.utils.ReportingSet
Sets the log that the reporting set will log to.
setLogLevel(Log.Level) - Method in class org.apache.rat.utils.ReportingSet
Sets the log level that the reporting set will log at.
setMatch(boolean) - Method in class org.apache.rat.header.HeaderBean
 
setMatcher(IHeaderMatcher) - Method in class org.apache.rat.license.ILicense.Builder
Sets the matcher.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.license.ILicense.Builder
Sets the matcher from a builder.
setMatchers(Map<String, IHeaderMatcher>) - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder
Set the Map of matcher ids to matcher instances.
setMsgFormat(Function<T, String>) - Method in class org.apache.rat.utils.ReportingSet
Sets the function to generate the log message.
setName(String) - Method in class org.apache.rat.configuration.builders.SpdxBuilder
sets the name for the SPDX matcher
setName(String) - Method in class org.apache.rat.license.ILicense.Builder
Sets the name of the license.
setNotes(String) - Method in class org.apache.rat.analysis.license.BaseLicense
Deprecated.
 
setNotes(String) - Method in class org.apache.rat.license.ILicense.Builder
Sets the notes for the license.
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.
setOut(File) - Method in class org.apache.rat.ReportConfiguration
Sets the OutputStream supplier to use the specified file.
setOut(IOSupplier<OutputStream>) - Method in class org.apache.rat.ReportConfiguration
Sets the supplier for the output stream.
setOwner(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder
Sets the owner.
setPatterns(String[]) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
Deprecated.
 
setRefId(String) - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder
Constructs the MatcherReferenceBuilder using the provided reference id.
setReportable(IReportable) - Method in class org.apache.rat.ReportConfiguration
 
setResource(String) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
Reads a text file.
setStart(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder
Sets the start date.
setStyleReport(boolean) - Method in class org.apache.rat.ReportConfiguration
 
setStyleSheet(File) - Method in class org.apache.rat.ReportConfiguration
 
setStyleSheet(URI) - Method in class org.apache.rat.ReportConfiguration
Sets the style sheet for custom processing.
setStyleSheet(URL) - Method in class org.apache.rat.ReportConfiguration
Sets the style sheet for custom processing.
setStyleSheet(IOSupplier<InputStream>) - Method in class org.apache.rat.ReportConfiguration
Sets the style sheet for custom processing.
setText(String) - Method in class org.apache.rat.configuration.builders.TextBuilder
 
setText(String) - Method in interface org.apache.rat.configuration.builders.TextCaptureBuilder
 
SimpleLicenseFamily - Class in org.apache.rat.license
Deprecated.
SimpleLicenseFamily() - Constructor for class org.apache.rat.license.SimpleLicenseFamily
Deprecated.
 
SimplePatternBasedLicense - Class in org.apache.rat.analysis.license
Deprecated.
Use new configuration options
SimplePatternBasedLicense() - Constructor for class org.apache.rat.analysis.license.SimplePatternBasedLicense
Deprecated.
 
SimpleRegexMatcher - Class in org.apache.rat.analysis.matchers
A simple regular expression matching IHeaderMatcher
SimpleRegexMatcher(String, Pattern) - Constructor for class org.apache.rat.analysis.matchers.SimpleRegexMatcher
Constructs a regex pattern matcher with a unique random id and the specified Regex pattern.
SimpleRegexMatcher(Pattern) - Constructor for class org.apache.rat.analysis.matchers.SimpleRegexMatcher
Constructs a regex pattern matcher with a unique random id and the specified Regex pattern.
SimpleTextMatcher - Class in org.apache.rat.analysis.matchers
A simple text matching IHeaderMatcher implementation.
SimpleTextMatcher(String) - Constructor for class org.apache.rat.analysis.matchers.SimpleTextMatcher
Constructs the simple text matcher for the simple string.
SimpleTextMatcher(String, String) - Constructor for class org.apache.rat.analysis.matchers.SimpleTextMatcher
Constructs the simple text matcher for the simple string.
SimpleXmlClaimReporter - Class in org.apache.rat.report.claim.impl.xml
 
SimpleXmlClaimReporter(IXmlWriter) - Constructor for class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
 
size() - Method in class org.apache.rat.utils.ReportingSet
 
SourceCodeManagementSystems - Enum in org.apache.rat.config
 
spdx() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
SpdxBuilder - Class in org.apache.rat.configuration.builders
A build for SPDX matchers.
SpdxBuilder() - Constructor for class org.apache.rat.configuration.builders.SpdxBuilder
 
SPDXMatcherFactory - Class in org.apache.rat.analysis.matchers
Defines a factory to produce matchers for an SPDX tag.
SPDXMatcherFactory.Match - Class in org.apache.rat.analysis.matchers
 
spliterator() - Method in class org.apache.rat.utils.ReportingSet
 
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
Empty default implementation.
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
Signals the start of execution for the report.
stream() - Method in class org.apache.rat.utils.ReportingSet
 
subSet(T, T) - Method in class org.apache.rat.utils.ReportingSet
 
SUBVERSION - Enum constant in enum org.apache.rat.config.SourceCodeManagementSystems
 

T

t - Enum constant in enum org.apache.rat.analysis.IHeaderMatcher.State
 
tailSet(T) - Method in class org.apache.rat.utils.ReportingSet
 
text() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder
 
TextBuilder - Class in org.apache.rat.configuration.builders
Builds text based matcher based on the complexity of the text to match.
TextBuilder() - Constructor for class org.apache.rat.configuration.builders.TextBuilder
 
TextCaptureBuilder - Interface in org.apache.rat.configuration.builders
A marker interface for builders that accept text plain text to match.
toArray() - Method in class org.apache.rat.utils.ReportingSet
 
toArray(T[]) - Method in class org.apache.rat.utils.ReportingSet
 
toName(File) - Static method in class org.apache.rat.document.impl.DocumentImplUtils
 
toNameTransformer() - Static method in class org.apache.rat.document.ToNameTransformer
 
ToNameTransformer - Class in org.apache.rat.document
 
ToNameTransformer() - Constructor for class org.apache.rat.document.ToNameTransformer
 
toString() - Method in enum org.apache.rat.analysis.IHeaderMatcher.State
 
toString() - Method in class org.apache.rat.analysis.matchers.AbstractHeaderMatcher
 
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.configuration.builders.AbstractBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.CopyrightBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.NotBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.RegexBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.SpdxBuilder
 
toString() - Method in class org.apache.rat.configuration.builders.TextBuilder
 
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.
toString() - Method in class org.apache.rat.license.SimpleLicenseFamily
Deprecated.
 
toString() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
TOTAL_READ_RATIO - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser
 
transform(Object) - Method in class org.apache.rat.document.ToNameTransformer
 
TRUE - Enum constant in enum org.apache.rat.config.AddLicenseHeaders
 
TXT - Enum constant in enum org.apache.rat.configuration.Format
A plain text file
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
The default XSLT stylesheet to produce a list of unapproved licenses.
UnknownLicense - Class in org.apache.rat.analysis
An ILicense implementation that represents an unknown license.
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) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 
UnsuitableDocumentException(String, Throwable) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 
UnsuitableDocumentException(Throwable) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException
 

V

validate(Consumer<String>) - Method in class org.apache.rat.ReportConfiguration
Validates that the configuration is valid.
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.analysis.IHeaderMatcher.State
Returns the enum constant of this type with the specified 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.
valueOf(String) - Static method in enum org.apache.rat.configuration.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.utils.Log.Level
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.utils.ReportingSet.Options
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.rat.analysis.IHeaderMatcher.State
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.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.
values() - Static method in enum org.apache.rat.configuration.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.utils.Log.Level
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.utils.ReportingSet.Options
Returns an array containing the constants of this enum type, in the order they are declared.

W

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
 
warn(Object) - Method in interface org.apache.rat.utils.Log
 
WARN - Enum constant in enum org.apache.rat.utils.Log.Level
Log warn only.
write(byte[]) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
write(byte[], int, int) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
write(int) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
 
writeClaim(String, String, boolean) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter
Writes a single claim to the XML file.

X

XML - Enum constant in enum org.apache.rat.config.ReportFormat
 
XML - Enum constant in enum org.apache.rat.configuration.Format
an XML file
XMLConfigurationReader - Class in org.apache.rat.configuration
A class that reads the XML configuration file format.
XMLConfigurationReader() - Constructor for class org.apache.rat.configuration.XMLConfigurationReader
Constructs the XML configuration reader.
XmlReportFactory - Class in org.apache.rat.report.xml
A factory to create reports from a writer and a configuration.
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
Constructs an XmlWriter with the specified writer for output.
A B C D E F G H I J L M N O P R S T U V W X 
All Classes|All Packages|Constant Field Values|Deprecated API|Serialized Form