Index (Apache Creadur Rat::Core 0.17-SNAPSHOT API)

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

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.
AbstractHelp - Class in org.apache.rat.help
AbstractHelp() - Constructor for class org.apache.rat.help.AbstractHelp
AbstractHelp.RatHelpFormatter - Class in org.apache.rat.help
AbstractLicenseAppender - Class in org.apache.rat.annotation: Add a license header to a document.
AbstractLicenseAppender() - 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>, String) - Constructor for class org.apache.rat.analysis.matchers.AbstractMatcherContainer: Constructs the abstract matcher container.
AbstractMatcherContainer(Collection<? extends IHeaderMatcher>, String) - Constructor for class org.apache.rat.analysis.matchers.AbstractMatcherContainer: Constructs the abstract matcher container with a unique random id.
AbstractReport - Class in org.apache.rat.report: Abstract base class for deriving implementations of RatReport.
AbstractReport() - Constructor for class org.apache.rat.report.AbstractReport
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(Document) - Method in class org.apache.rat.configuration.XMLConfigurationReader: Merge the new document into the document that this reader processes is building.
add(URI) - Method in class org.apache.rat.Defaults.Builder: Adds a URL to 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(File) - Method in class org.apache.rat.Defaults.Builder: Adds a configuration file to be read.
add(LicenseSetFactory) - Method in class org.apache.rat.license.LicenseSetFactory
add(ILicenseFamily) - Method in class org.apache.rat.policy.DefaultPolicy: Adds an ILicenseFamily to the list of approved licenses.
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(ILicenseFamily) - Method in class org.apache.rat.ReportConfiguration: Adds an ILicenseFamily to the list of approved licenses.
addApprovedLicenseCategory(String) - Method in class org.apache.rat.ReportConfiguration: Adds a license family category (id) to the list of approved licenses
addApprovedLicenseId(ILicense) - Method in class org.apache.rat.ReportConfiguration: Adds an ILicenseFamily to the list of approved licenses.
addApprovedLicenseId(String) - Method in class org.apache.rat.ReportConfiguration: Adds a license family category (id) to the list of approved licenses
addApprovedLicenseIds(Collection<String>) - Method in class org.apache.rat.ReportConfiguration: Adds a collection of license family categories to the set of approved license names.
addBuilder(String, String) - Static method in class org.apache.rat.configuration.MatcherBuilderTracker: Adds a builder to the tracker.
addDirectoryToIgnore(IOFileFilter) - Method in class org.apache.rat.ReportConfiguration: Adds a directory filter to the directories to ignore.
addEnclosed(IHeaderMatcher.Builder) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder: Adds a builder to the list of builders.
addEnclosed(Collection<IHeaderMatcher.Builder>) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder: Adds a collection of builders to the list of child builders.
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.license.LicenseSetFactory: Adds a license family to the list of families.
addFamily(ILicenseFamily.Builder) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license family to the list of 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.license.LicenseSetFactory: Adds a license to the list of licenses.
addLicense(ILicense.Builder) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license to the list of licenses.
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.
addLicenseCategory(String) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license family category (id) to the list of approved licenses
AddLicenseHeaders - Enum in org.apache.rat.config: Value of addLicenseHeaders configuration option.
addLicenseId(String) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license family category (id) to the list of approved licenses
addLicenses(URI) - Method in interface org.apache.rat.configuration.LicenseReader: Adds an URI to the set of files to be read.
addLicenses(URI) - Method in class org.apache.rat.configuration.XMLConfigurationReader
addLicenses(Collection<ILicense>) - Method in class org.apache.rat.license.LicenseSetFactory: Adds multiple licenses to the list of licenses.
addLicenses(Collection<ILicense>) - Method in class org.apache.rat.ReportConfiguration: Adds multiple licenses to the list of licenses.
addMatchers(URI) - Method in interface org.apache.rat.configuration.MatcherReader: Adds an URI to the set of files to be read.
addMatchers(URI) - Method in class org.apache.rat.configuration.XMLConfigurationReader
all() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new AllBuilder()
AllBuilder - Class in org.apache.rat.configuration.builders: Constructs an 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>, String) - Constructor for class org.apache.rat.analysis.matchers.AndMatcher: Constructs the AndMatcher with the specified id and enclosed collection.
AndMatcher(Collection<? extends IHeaderMatcher>, String) - 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: Deprecated.
Use new AnyBuilder()
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() - 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.
APPROVED - Static variable in class org.apache.rat.configuration.XMLConfig: approved element name
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
approvedLicenses() - Method in class org.apache.rat.api.MetaData: Gets the stream of approved licenses that have been matched.
ARCHIVE_PROCESSING - Static variable in class org.apache.rat.Defaults: The default ARCHIVES processing style
ArchiveEntryDocument - Class in org.apache.rat.document.impl: A Document that wraps an Archive entry.
ArchiveEntryDocument(Path, byte[]) - Constructor for class org.apache.rat.document.impl.ArchiveEntryDocument: Creates an Archive entry.
ArchiveWalker - Class in org.apache.rat.walker: Walks various kinds of archives files
ArchiveWalker(ReportConfiguration, Document) - Constructor for class org.apache.rat.walker.ArchiveWalker: Constructs a walker.
Arg - Enum in org.apache.rat.commandline: An enumeration of options.
arg() - Method in enum org.apache.rat.commandline.StyleSheets: Gets the name of the xslt file.
Arg.StdMsgs - Class in org.apache.rat.commandline: Standard messages used in descriptions.
ArgumentContext - Class in org.apache.rat.commandline: Provides the context necessary to process various arguments.
ArgumentContext(ReportConfiguration, CommandLine) - Constructor for class org.apache.rat.commandline.ArgumentContext: Constructor.
asRatException(Exception) - Static method in exception org.apache.rat.api.RatException
assemble(String[]) - Method in enum org.apache.rat.utils.CasedString.StringCase: Creates a cased string from a collection of segments.
asWriter() - Method in interface org.apache.rat.utils.Log: Returns a Writer backed by this log.
ATT_CLASS_NAME - Static variable in class org.apache.rat.configuration.XMLConfig: class name attribute name
ATT_ID - Static variable in class org.apache.rat.configuration.XMLConfig: id attribute name
ATT_LICENSE_REF - Static variable in class org.apache.rat.configuration.XMLConfig: license reference attribute name
ATT_NAME - Static variable in class org.apache.rat.configuration.XMLConfig: name attribute name
ATT_REF_ID - Static variable in class org.apache.rat.configuration.builders.MatcherRefBuilder: the reference id attribute
ATT_RESOURCE - Static variable in class org.apache.rat.configuration.XMLConfig: resource file name attribute name.
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.
build() - Method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Build the IHeaderMatcher.
build(Object) - Static method in class org.apache.rat.config.parameters.DescriptionBuilder: Create the description for the object.
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.ILicense.Builder: Builds the license.
build() - Method in interface org.apache.rat.license.ILicenseFamily.Builder: Builds the defined license family.
build() - Method in class org.apache.rat.license.ILicenseFamilyBuilder
build() - Method in class org.apache.rat.license.SimpleLicense.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: Gets a builder for licenses.
builder() - Static method in interface org.apache.rat.license.ILicenseFamily: Gets the Builder for license families.
Builder() - Constructor for class org.apache.rat.license.SimpleLicense.Builder
BuilderParams - Interface in org.apache.rat: Parameters that can be set by the BUILDER_PARAM ComponentType.
buildMap(Class<?>) - Static method in class org.apache.rat.config.parameters.DescriptionBuilder: Create a description for a class.
buildOptions() - Static method in class org.apache.rat.OptionCollection: Create an Options object from the list of defined Options.

C

CasedString - Class in org.apache.rat.utils: Handles converting from one string case to another (e.g. camel case to snake case).
CasedString(CasedString.StringCase, String) - Constructor for class org.apache.rat.utils.CasedString: A representation of a cased string and the identified case of that string.
CasedString.StringCase - Enum in org.apache.rat.utils: An enumeration of supported string cases.
cdata(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
cdata(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Writes CDATA content.
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.
childrenOfType(ComponentType) - Method in class org.apache.rat.config.parameters.Description: Get all the children of a specific type
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: Constructor.
ClaimReporterMultiplexer - Class in org.apache.rat.report.claim.util: Executes a RatReport that multiplexes the running of multiple RatReports
ClaimReporterMultiplexer(IXmlWriter, boolean, IDocumentAnalyser, List<? extends RatReport>) - Constructor for class org.apache.rat.report.claim.util.ClaimReporterMultiplexer: A multiplexer to run multiple claim reports.
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
ClaimStatistic.Counter - Enum in org.apache.rat.report.claim: The counter types
clear() - Method in class org.apache.rat.utils.ReportingSet
close() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
close() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream: Does not actually close the delegate.
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(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter: Closes back to and including the last instance of the specified element name.
closeElement() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Closes the last element written.
closeElement(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Closes all open elements back to and including the named element.
comment(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
comment(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Writes a comment
comparator() - Method in class org.apache.rat.utils.ReportingSet
compareTo(Document) - Method in class org.apache.rat.api.Document
compareTo(ILicense) - Method in interface org.apache.rat.license.ILicense
compareTo(ILicenseFamily) - Method in interface org.apache.rat.license.ILicenseFamily
ComponentType - Enum in org.apache.rat.config.parameters: Types of components
ConfigComponent - Annotation Type in org.apache.rat.config.parameters: An annotation that marks a configuration component.
ConfigurationException - Exception in org.apache.rat: An exception thrown when there is an issue with the Configuration.
ConfigurationException(String, Throwable) - Constructor for exception org.apache.rat.ConfigurationException
ConfigurationException(String) - Constructor for exception org.apache.rat.ConfigurationException
ConfigurationException(Throwable) - Constructor for exception org.apache.rat.ConfigurationException
ConfigurationReport - Class in org.apache.rat.report: A report that dumps the ReportConfiguration into the XML output.
ConfigurationReport(IXmlWriter, ReportConfiguration) - Constructor for class org.apache.rat.report.ConfigurationReport: Constructor.
contains(Object) - Method in class org.apache.rat.utils.ReportingSet
containsAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
content(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter
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: Deprecated.
Use new CopyrightBuilder()
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(ReportConfiguration) - Static method in class org.apache.rat.analysis.DefaultAnalyserFactory: Creates a DocumentAnalyser from a collection of ILicenses.
createPadding(int) - Static method in class org.apache.rat.help.AbstractHelp: Create a padding.
createStandardReport(IXmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a RatReport from the arguments.

D

debug(Object) - Method in interface org.apache.rat.utils.Log: Write a message at DEBUG level.
debug(Object, Throwable) - Method in interface org.apache.rat.utils.Log: Write a debug message and report throwable stack trace.
DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES - Static variable in class org.apache.rat.analysis.HeaderCheckWorker: The default number of header lines to read while looking for the license information.
DefaultAnalyserFactory - Class in org.apache.rat.analysis: Creates default analysers.
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 provides the standard system defaults for the ReportConfiguration.
Defaults.Builder - Class in org.apache.rat: The Defaults builder.
defaultValue() - Method in enum org.apache.rat.commandline.Arg
DEPRECATED_MSG - Static variable in class org.apache.rat.help.AbstractHelp: Function to format deprecated display
DeprecatedConfig - Interface in org.apache.rat.analysis.license: Deprecated.
DeprecationReporter - Class in org.apache.rat: Reporting methods for deprecated objects.
DeprecationReporter.Info - Annotation Type in org.apache.rat: Annotation to provide deprecation information for Java8.
desc() - Method in enum org.apache.rat.commandline.StyleSheets: Gets the description of the xslt file.
desc() - Method in enum org.apache.rat.ReportConfiguration.Processing: Gets the description of the processing type.
Description - Class in org.apache.rat.config.parameters: A description of a component.
Description(ComponentType, String, String, boolean, Class<?>, Collection<Description>, boolean) - Constructor for class org.apache.rat.config.parameters.Description: Constructor.
Description(ConfigComponent, boolean, Class<?>, Collection<Description>) - Constructor for class org.apache.rat.config.parameters.Description: Constructor
DescriptionBuilder - Class in org.apache.rat.config.parameters: Builds Description objects for the various Component instances.
detectedLicense() - Method in class org.apache.rat.api.MetaData: Determines if a matching license has been detected.
DIRECTORIES_TO_IGNORE - Static variable in class org.apache.rat.Defaults: The default directories to ignore
DirectoryWalker - Class in org.apache.rat.walker: Walks directories.
DirectoryWalker(ReportConfiguration, Document) - Constructor for class org.apache.rat.walker.DirectoryWalker: Constructs a directory walker.
Document - Class in org.apache.rat.api: The representation of a document being scanned.
Document(String) - Constructor for class org.apache.rat.api.Document: Creates an instance.
Document.Type - Enum in org.apache.rat.api: An enumeraton of document types.
DocumentAnalyserMultiplexer - Class in org.apache.rat.document.impl.util
DocumentAnalyserMultiplexer(IDocumentAnalyser[]) - Constructor for class org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer

E

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.
endReport(IXmlWriter) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Ends the XML reprot by closing the element that startReport opened.
equals(Object) - Method in class org.apache.rat.analysis.UnknownLicense
equals(Object) - Method in class org.apache.rat.api.Document
equals(ILicense, Object) - Static method in interface org.apache.rat.license.ILicense: A default implementation of equals.
equals(Object) - Method in class org.apache.rat.license.SimpleLicense
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: Write a message at ERROR level.
error(Object, Throwable) - Method in interface org.apache.rat.utils.Log: Write an error message and report throwable stack trace.

F

FAMILIES - Static variable in class org.apache.rat.configuration.XMLConfig: families element name
FAMILY - Static variable in class org.apache.rat.configuration.XMLConfig: family element name
familyDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.license.LicenseSetFactory: Sets the reporting option for duplicate license families.
familyDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.ReportConfiguration: Sets the reporting option for duplicate license families.
familySearch(String, SortedSet<ILicenseFamily>) - Static method in class org.apache.rat.license.LicenseSetFactory: Search a SortedSet of ILicenseFamily instances looking for a matching instance.
familySearch(ILicenseFamily, SortedSet<ILicenseFamily>) - Static method in class org.apache.rat.license.LicenseSetFactory: Search a SortedSet of ILicenseFamily instances looking for a matching instance.
FileDocument - Class in org.apache.rat.document.impl: Document wrapping a File object
FileDocument(File) - Constructor for class org.apache.rat.document.impl.FileDocument: Creates a File document.
FILES_TO_IGNORE - Static variable in class org.apache.rat.Defaults: The default files to ignore if none are specified.
filterChildren(Predicate<Description>) - Method in class org.apache.rat.config.parameters.Description: Get a filtered collection of the child descriptions.
find(String) - Method in enum org.apache.rat.commandline.Arg: Finds the element associated with the key within the element group.
findArg(Option) - Static method in enum org.apache.rat.commandline.Arg: Finds the Arg that an Option is in.
findArg(String) - Static method in enum org.apache.rat.commandline.Arg: Finds the Arg that contains an Option with the specified key.
first() - Method in class org.apache.rat.utils.ReportingSet
flush() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
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.
from(String) - Static method in enum org.apache.rat.configuration.Format: Determine the Format from the file name.
from(URI) - Static method in enum org.apache.rat.configuration.Format: Determine the Format from an URI.
from(File) - Static method in enum org.apache.rat.configuration.Format: Determine the Format from a file.
fromMediaType(MediaType) - Static method in class org.apache.rat.analysis.TikaProcessor
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.

constructor

G

GENTERATED_CATEGORY - Static variable in interface org.apache.rat.license.ILicenseFamily: The category for generated files
get(String) - Method in interface org.apache.rat.BuilderParams: Gets one of the contained methods by name.
getApprovedLicenseFamilies() - Method in class org.apache.rat.policy.DefaultPolicy: Gets an unmodifiable reference to the SortedSet of approved licenses that this policy is holding.
getArchiveProcessing() - Method in class org.apache.rat.ReportConfiguration: Retrieves the archive processing type.
getArgumentTypes() - Static method in class org.apache.rat.OptionCollection: Gets the mapping of argName(value) values to a description of those values.
getBuiltClass(Class<? extends IHeaderMatcher.Builder>) - Static method in class org.apache.rat.config.parameters.DescriptionBuilder
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.config.parameters.Description: Gets a map of the parameters that the object contains.
getChildType() - Method in class org.apache.rat.config.parameters.Description: Get the class of the objects for the getter/setter methods.
getClaimsStatistic() - Method in class org.apache.rat.Reporter: Get the claim statistics from the run.
getClasses() - Method in class org.apache.rat.configuration.MatcherBuilderTracker: Gets a collection of classes that are recognized as builders.
getCommandLine() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the command line.
getCommonName() - Method in class org.apache.rat.config.parameters.Description: Gets the common name for the matcher.
getConfiguration() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the configuration.
getCopyrightMessage() - Method in class org.apache.rat.ReportConfiguration: Returns the optional license copyright being added if RAT is adding headers.
getCounter(ClaimStatistic.Counter) - Method in class org.apache.rat.report.claim.ClaimStatistic: Returns the counts for the counter.
getCounter(Document.Type) - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the counts for the Document.Type.
getDescription() - Method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Gets the Description for this builder.
getDescription() - Method in interface org.apache.rat.analysis.IHeaderMatcher: Generates the component Description.
getDescription() - Method in class org.apache.rat.config.parameters.Description: Gets the description of descriptive text for the component.
getDescription() - Method in class org.apache.rat.license.SimpleLicense
getDirectoriesToIgnore() - Method in class org.apache.rat.ReportConfiguration: Gets the directories filter.
getDocument() - Method in class org.apache.rat.walker.Walker: Retrieves the document from the constructor.
getDocuments() - Method in class org.apache.rat.walker.ArchiveWalker: Retrieves the documents from the archive.
getDocumentType() - Method in class org.apache.rat.api.MetaData: Gets the document type.
getEnclosed() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer: Retrieves the collection of matchers that comprise the children of this matcher.
getEnclosed() - Method in class org.apache.rat.analysis.matchers.NotMatcher
getEnclosed() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
getEnclosedBuilders() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
getEnd() - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher: Gets the end date of the copyright.
getExclusions() - Method in enum org.apache.rat.config.SourceCodeManagementSystems: If an ignore file exists it's added as *⁄.scm⁄* .
getFamily() - Method in class org.apache.rat.license.SimpleLicense
getFamilyCategory() - Method in interface org.apache.rat.license.ILicenseFamily: Gets the family category.
getFamilyCategory() - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
getFamilyName() - Method in interface org.apache.rat.license.ILicense: Gets the name of the family that this license if part of.
getFamilyName() - Method in interface org.apache.rat.license.ILicenseFamily: Gets the family name.
getFamilyName() - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
getFilesToIgnore() - Method in class org.apache.rat.ReportConfiguration: Gets the file name filter for files to ignore.
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: Deprecated.

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: Gets the ID as specified in the builder.
getId() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy
getId() - Method in class org.apache.rat.license.SimpleLicense
getIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems: Maybe null, check before with
getInstance() - Static method in class org.apache.rat.utils.DefaultLog: Retrieves teh DefaultLog instance.
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: Gets the level we are writing at.
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.
getLicenseCategories(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseSetFactory: Gets the License ids based on the filter.
getLicenseCategories(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Gets the SortedSet of approved license categories.
getLicenseCategoryCount(String) - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the counts for hte license category.
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.
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: Gets the license family.
getLicenseFamily() - Method in class org.apache.rat.license.SimpleLicense
getLicenseFamilyCategories() - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the set of license family categories that were seen.
getLicenseFamilyCategory() - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
getLicenseFamilyName() - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
getLicenseFamilyNameCount(String) - Method in class org.apache.rat.report.claim.ClaimStatistic: Retrieves the number of times a license family name was seen.
getLicenseFamilyNames() - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the set of license family names that were seen.
getLicenseHeader(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Gets the header text to insert into the file.
getLicenseHeader(File) - Method in class org.apache.rat.annotation.ApacheV2LicenseAppender
getLicenseIds(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.license.LicenseSetFactory: Gets the License ids based on the filter.
getLicenseIds(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Gets the SortedSet of approved license categories.
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 the SortedSet of approved license categories.
getLicenseSetFactory() - Method in class org.apache.rat.Defaults: Gets the default license set factory.
getLicenseSetFactory() - Method in class org.apache.rat.ReportConfiguration
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: Deprecated.
getLogReporter() - Static method in class org.apache.rat.DeprecationReporter: Creates the consumer that will log usage of deprecated operations to the default log.
getMatcher() - Method in class org.apache.rat.analysis.UnknownLicense
getMatcher() - Method in interface org.apache.rat.license.ILicense: Get the header matcher for this license.
getMatcher() - Method in class org.apache.rat.license.SimpleLicense
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.
getMediaType() - Method in class org.apache.rat.api.MetaData: Gets the defined media type.
getMetaData() - Method in class org.apache.rat.api.Document: Gets data describing this resource.
getName() - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match
getName() - Method in class org.apache.rat.analysis.UnknownLicense
getName() - Method in class org.apache.rat.api.Document
getName() - Method in interface org.apache.rat.license.ILicense: Returns the name of this license.
getName() - Method in class org.apache.rat.license.SimpleLicense
getNote() - Method in class org.apache.rat.analysis.UnknownLicense
getNote() - Method in interface org.apache.rat.license.ILicense: Gets the note associated with the license.
getNote() - Method in class org.apache.rat.license.SimpleLicense
getNotes() - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
getOptions() - Static method in enum org.apache.rat.commandline.Arg: Gets the full set of options.
getOutput() - Method in class org.apache.rat.ReportConfiguration: Returns the output stream supplier.
getOwner() - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher: Gets the owner of the copyright.
getParameters() - Method in class org.apache.rat.api.ContentType: Gets an immutable map containing all content type parameters with keys normalised to lower case.
getParamValue(Object) - Method in class org.apache.rat.config.parameters.Description: Retrieve the value of a the described parameter from the specified object.
getPath() - Method in class org.apache.rat.api.Document: Get the path that identifies the document.
getPath() - Method in class org.apache.rat.document.impl.FileDocument
getPattern() - Method in class org.apache.rat.analysis.matchers.SimpleRegexMatcher
getPatterns() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense: Deprecated.
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.
getRefId() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy: Get the reference ID that this proxy is using.
getReportable() - Method in class org.apache.rat.ReportConfiguration: Gets the reportable object.
getResource() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer: Get the resource that was provided in the constructor.
getSampleHeader() - Method in class org.apache.rat.api.MetaData: Gets the sample header.
getSegments() - Method in class org.apache.rat.utils.CasedString: Returns an array of each of the segments in this CasedString.
getSegments(String) - Method in enum org.apache.rat.utils.CasedString.StringCase: Returns an array of each of the segments in this CasedString.
getSelected() - Method in enum org.apache.rat.commandline.Arg: Gets the select element from the group.
getSimpleText() - Method in class org.apache.rat.analysis.matchers.SimpleTextMatcher
getSpecTitle() - Method in class org.apache.rat.VersionInfo: Gets the specification title of the package.
getSpecVendor() - Method in class org.apache.rat.VersionInfo: Gets the specification vendor of the package.
getSpecVersion() - Method in class org.apache.rat.VersionInfo: Gets the specification version of the package.
getStandardProcessing() - Method in class org.apache.rat.ReportConfiguration: Retrieves the archive processing type.
getStart() - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher: Gets the start date of the copyright.
getStyleSheet() - Method in enum org.apache.rat.commandline.StyleSheets: Gets the IOSupplier for a style sheet.
getStyleSheet(String) - Static method in enum org.apache.rat.commandline.StyleSheets: Gets the IOSupplier for a style sheet.
getStyleSheet() - Method in class org.apache.rat.ReportConfiguration: Gets the IOSupplier with the style sheet.
getSubType() - Method in class org.apache.rat.api.ContentType: Gets the media sub type normalised to lower case
getter(Class<?>) - Method in class org.apache.rat.config.parameters.Description: Returns the getter for the component in the specified class.
getTitle() - Method in class org.apache.rat.VersionInfo: Gets the implementation title of the package.
getType(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Detect the type of document.
getType() - Method in class org.apache.rat.config.parameters.Description: Gets the type of the component.
getValuesForHelp() - Static method in enum org.apache.rat.config.AddLicenseHeaders
getVendor() - Method in class org.apache.rat.VersionInfo: Gets the implementation vendor of the package.
getVersion() - Method in class org.apache.rat.VersionInfo: Gets the implementation version of the package.
getWriter() - Method in class org.apache.rat.ReportConfiguration: Gets a PrintWriter that wraps the output stream.
group() - Method in enum org.apache.rat.commandline.Arg: Gets the group for this arg.
GuessUtils - Class in org.apache.rat.document.impl.guesser
GuessUtils() - Constructor for class org.apache.rat.document.impl.guesser.GuessUtils

H

handleApprovedLicenseClaim(MetaData) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter: Increment the approved license claim.
handleApprovedLicenseClaim(MetaData) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
handleDocumentCategoryClaim(Document.Type) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter: Increment the document type counter.
handleDocumentCategoryClaim(Document.Type) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
handleLicenseClaim(ILicense) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter: Increment the counts associated with the license The default implementation does nothing.
handleLicenseClaim(ILicense) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator
hash(ILicense) - Static method in interface org.apache.rat.license.ILicense: A default implementatin of a License hash
hashCode() - Method in class org.apache.rat.analysis.UnknownLicense
hashCode() - Method in class org.apache.rat.api.Document
hashCode() - Method in class org.apache.rat.license.SimpleLicense
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: Returns true if this builder has an ID specified.
hasIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems
header(String) - Static method in class org.apache.rat.help.AbstractHelp: Create a section header for the output.
HeaderBean - Class in org.apache.rat.header: Deprecated.
HeaderBean() - Constructor for class org.apache.rat.header.HeaderBean: Deprecated.
HeaderBean(Pattern, boolean) - Constructor for class org.apache.rat.header.HeaderBean: Deprecated.
HeaderCheckWorker - Class in org.apache.rat.analysis: Reads from a stream to check license.
HeaderCheckWorker(Reader, Collection<ILicense>, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker: Convenience constructor wraps given Reader in a BufferedReader.
HeaderCheckWorker(Reader, int, Collection<ILicense>, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker: Constructs a check worker for the license against the specified document.
HeaderMatcher - Class in org.apache.rat.header: Deprecated.
HeaderMatcher(CharFilter, int) - Constructor for class org.apache.rat.header.HeaderMatcher: Deprecated.
HeaderMatcher(CharFilter, int, HeaderBean[]) - Constructor for class org.apache.rat.header.HeaderMatcher: Deprecated.
headSet(T) - Method in class org.apache.rat.utils.ReportingSet
Help - Class in org.apache.rat.help
Help(Writer) - Constructor for class org.apache.rat.help.Help
Help(PrintStream) - Constructor for class org.apache.rat.help.Help
HELP - Static variable in class org.apache.rat.OptionCollection: Produce help
HELP_PADDING - Static variable in class org.apache.rat.help.AbstractHelp: The number of chars to indent output with.
HELP_WIDTH - Static variable in class org.apache.rat.help.AbstractHelp: The width of the help report in chars.
helpFormatter - Variable in class org.apache.rat.help.AbstractHelp
HIDDEN - Static variable in class org.apache.rat.walker.NameBasedHiddenFileFilter: Singleton instance of hidden filter.

I

IDocumentAnalyser - Interface in org.apache.rat.document
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.
IHeaderMatcherProxy(String, Map<String, IHeaderMatcher>) - Constructor for class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy: Constuctor.
IHeaders - Interface in org.apache.rat.analysis: The processed headers from a file.
ILicense - Interface in org.apache.rat.license: The definition of a License.
ILicense.Builder - Interface 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
ImplementationException - Exception in org.apache.rat: An exception thrown when there is an issue with the configuration.
ImplementationException(String, Throwable) - Constructor for exception org.apache.rat.ImplementationException
ImplementationException(String) - Constructor for exception org.apache.rat.ImplementationException
ImplementationException(Throwable) - Constructor for exception org.apache.rat.ImplementationException
incCounter(ClaimStatistic.Counter, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the counts for hte counter.
incCounter(Document.Type, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the number of times the Document.Type was seen.
incLicenseCategoryCount(String, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the number of times a license family category was seen.
incLicenseFamilyNameCount(String, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the license family name count.
info(Object) - Method in interface org.apache.rat.utils.Log: Write a message at INFO level.
info(Object, Throwable) - Method in interface org.apache.rat.utils.Log: Write an info message and report throwable stack trace.
init() - Static method in class org.apache.rat.Defaults: Initialize the system configuration reader.
inputStream() - Method in class 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
INSTANCE - Static variable in class org.apache.rat.analysis.matchers.SPDXMatcherFactory: The instance of this factory.
INSTANCE - Static variable in class org.apache.rat.analysis.UnknownLicense: The single instance of this class.
instance() - Static method in class org.apache.rat.configuration.MatcherBuilderTracker: Gets the instance of the MatcherBuilderTracker.
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.
isApproved(ILicense) - Method in class org.apache.rat.api.MetaData: Determine if the license is an approved license.
isCollection() - Method in class org.apache.rat.config.parameters.Description: Get the isCollection flag.
isDirectory() - Method in class org.apache.rat.api.Document: Determines if this Document is a directory type.
isDirectory() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
isDirectory() - Method in class org.apache.rat.document.impl.FileDocument
isDryRun() - Method in class org.apache.rat.ReportConfiguration: Returns the state of the dry run flag.
isEmpty() - Method in class org.apache.rat.utils.ReportingSet
isInlineNode(String, String) - Static method in class org.apache.rat.configuration.XMLConfig: Returns true if the specified child node should be placed inline in the XML document.
isLicenseChild(String) - Static method in class org.apache.rat.configuration.XMLConfig: Returns true if the child should be a child node of a license node, as opposed to a attribute of the license.
isLicenseInline(String) - Static method in class org.apache.rat.configuration.XMLConfig: Return true if the child should be inlined in the parent node.
isMatch() - Method in class org.apache.rat.header.HeaderBean: Deprecated.
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(Path) - Method in class org.apache.rat.walker.Walker: Tests if the specified path should be ignored.
isRequired() - Method in class org.apache.rat.config.parameters.Description: Get the canBeChild flag.
isSelected() - Method in enum org.apache.rat.commandline.Arg: Determines if the group has a selected element.
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.

L

last() - Method in class org.apache.rat.utils.ReportingSet
LICENSE - Static variable in class org.apache.rat.configuration.XMLConfig: license element name
LicenseAddingReport - Class in org.apache.rat.report.claim.util: A Report that adds licenses text to files.
LicenseAddingReport(String, boolean) - Constructor for class org.apache.rat.report.claim.util.LicenseAddingReport: Creates a LicenseAddingReport that inserts the copyright message and may overwrite the files.
licenseDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.license.LicenseSetFactory: Sets the reporting option for duplicate licenses.
licenseDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.ReportConfiguration: Sets the reporting option for duplicate licenses.
licenseFamilies() - Method in interface org.apache.rat.BuilderParams: Gets a sorted set of registered license families.
licenseReader() - Method in enum org.apache.rat.configuration.Format
LicenseReader - Interface in org.apache.rat.configuration: An interface describing the methods of a LicenseReader.
licenses() - Method in class org.apache.rat.api.MetaData: Gets the stream of licenses that have been matched.
LICENSES - Static variable in class org.apache.rat.configuration.XMLConfig: licenses element name
Licenses - Class in org.apache.rat.help: Generates text based documentation for Licenses, LicenceFamilies, and Matchers.
Licenses(ReportConfiguration, Writer) - Constructor for class org.apache.rat.help.Licenses: Constructor
LicenseSetFactory - Class in org.apache.rat.license: Class to take a set of ILicenses and collection of approved license categories and extract Subsets.
LicenseSetFactory() - Constructor for class org.apache.rat.license.LicenseSetFactory: Constructs a factory with the specified set of Licenses and the approved license collection.
LicenseSetFactory(SortedSet<ILicense>) - 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: Deprecated.
LineNumberReader(Reader) - Constructor for class org.apache.rat.header.LineNumberReader: Deprecated.
lines() - Method in class org.apache.rat.header.HeaderMatcher: Deprecated.

Number of lines read.
LIST_FAMILIES - Static variable in class org.apache.rat.Defaults: The default license families to list
LIST_LICENSES - Static variable in class org.apache.rat.Defaults: The default licenses to list
listChildren() - Method in class org.apache.rat.api.Document: Gets a sorted set of Documents that are children of this document.
listChildren() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument
listChildren() - Method in class org.apache.rat.document.impl.FileDocument
listFamilies(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Set the level of license families that should be output in the XML document.
listFamilies() - Method in class org.apache.rat.ReportConfiguration
listLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Set the level of licenses that should be output in the XML document.
listLicenses() - Method in class org.apache.rat.ReportConfiguration: Gets the selected license filter.
listLicenses(ReportConfiguration, LicenseSetFactory.LicenseFilter) - Static method in class org.apache.rat.Reporter: lists the licenses on the configured output stream.
log(Log.Level, String) - Method in class org.apache.rat.utils.DefaultLog
Log - Interface in org.apache.rat.utils: The definition of logging for the core.
log(Log.Level, String) - Method in interface org.apache.rat.utils.Log: Writes a message at a specific log level.
log(Log.Level, Object) - Method in interface org.apache.rat.utils.Log: Write a log message at the specified level.
log(Log.Level, String, Throwable) - Method in interface org.apache.rat.utils.Log: Write a log message and report throwable stack trace at the specified log level.
log(Log.Level, Object, Throwable) - Method in interface org.apache.rat.utils.Log: Write a log message and report throwable stack trace at the specified log level.
Log.Level - Enum in org.apache.rat.utils: The log levels supported by logging.
logDeprecated(Class<?>) - Static method in class org.apache.rat.DeprecationReporter: Log Deprecated class use.
logFamilyCollisions(Log.Level) - Method in class org.apache.rat.license.LicenseSetFactory: Set the log level for reporting collisions in the set of license families.
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.license.LicenseSetFactory: Sets the log level for reporting license collisions.
logLicenseCollisions(Log.Level) - Method in class org.apache.rat.ReportConfiguration: Sets the log level for reporting license collisions.
logParseException(ParseException, String, Object) - Method in class org.apache.rat.commandline.ArgumentContext: Logs a ParseException as a warning.
logParseException(ParseException, Option, Object) - Method in class org.apache.rat.commandline.ArgumentContext: Logs a ParseException as a warning.

M

main(String[]) - Static method in class org.apache.rat.Report: Processes the command line and builds a configuration and executes the report.
main(String[]) - Static method in class org.apache.rat.VersionInfo: Simple testing output.
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.
makeInstance(Exception) - Static method in exception org.apache.rat.api.RatException
makeInstance(Exception) - Static method in exception org.apache.rat.ImplementationException
MATCHER - Static variable in class org.apache.rat.configuration.XMLConfig: matcher element name
MatcherBuilder - Annotation Type in org.apache.rat.config.parameters: An annotation that marks a configuration component.
MatcherBuilderTracker - Class in org.apache.rat.configuration: A class to track the Matcher Builders as they are defined.
matcherMap() - Method in interface org.apache.rat.BuilderParams: Gets a mapping of matcher names to matchers.
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: Deprecated.
Use new MatcherRefBuilder()
MatcherRefBuilder - Class in org.apache.rat.configuration.builders: A reference matching Matcher builder.
MatcherRefBuilder() - Constructor for class org.apache.rat.configuration.builders.MatcherRefBuilder
MatcherRefBuilder.IHeaderMatcherProxy - Class in org.apache.rat.configuration.builders: A class that is a proxy to the actual matcher.
MATCHERS - Static variable in class org.apache.rat.configuration.XMLConfig: matchers element name
matches(IHeaders) - Method in interface org.apache.rat.analysis.IHeaderMatcher: Attempts to match text in the IHeaders instance.
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.AndMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.FullTextMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.NotMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.OrMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.SimpleRegexMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.SimpleTextMatcher
matches(IHeaders) - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match
matches(IHeaders) - Method in class org.apache.rat.analysis.UnknownLicense
matches(IHeaders) - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy
matches(Pattern) - Method in class org.apache.rat.header.HeaderMatcher: Deprecated.

Seeks a match in the last headers read.
matches(IHeaders) - Method in class org.apache.rat.license.SimpleLicense
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.
methodName(String) - Method in class org.apache.rat.config.parameters.Description: Generate a method name for this description.

N

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.
NoCloseOutputStream(OutputStream) - Constructor for class org.apache.rat.ReportConfiguration.NoCloseOutputStream: Constructor.
noDefault() - Method in class org.apache.rat.Defaults.Builder: Removes the default definitions from the list of files to process.
normalise(String) - Static method in class org.apache.rat.document.impl.guesser.GuessUtils: Converts name to upper case and strips any path.
normalizeFileName(File) - Static method in class org.apache.rat.document.impl.FileDocument: Normalizes a file name to linux style.
not() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new NotBuilder()
NotBuilder - Class in org.apache.rat.configuration.builders: A builder for the NotMatcher.
NotBuilder() - Constructor for class org.apache.rat.configuration.builders.NotBuilder
NOTE - Static variable in class org.apache.rat.configuration.XMLConfig: note element name
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.

O

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
option() - Method in enum org.apache.rat.commandline.Arg: Returns the first non-deprecated option from the group.
OptionCollection - Class in org.apache.rat: The collection of standard options for the CLI as well as utility methods to manage them and methods to create the ReportConfiguration from the options and an array of arguments.
optionComparator - Static variable in class org.apache.rat.OptionCollection
org.apache.rat - package org.apache.rat: The base package for the RAT tool.
org.apache.rat.analysis - package org.apache.rat.analysis: Classes that perform analyses of files.
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: Classes that update the files
org.apache.rat.api - package org.apache.rat.api: Key abstractions.
org.apache.rat.commandline - package org.apache.rat.commandline: Helper classes for command line processing.
org.apache.rat.config - package org.apache.rat.config: Contains source code management / revision control information used during plugin runs.
org.apache.rat.config.parameters - package org.apache.rat.config.parameters
org.apache.rat.configuration - package org.apache.rat.configuration: Classes to process configuration information from/to files.
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.help - package org.apache.rat.help
org.apache.rat.license - package org.apache.rat.license
org.apache.rat.policy - package org.apache.rat.policy: Policies for various methods of reporting.
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: Classes that write the XML output.
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: Classes with general utility across the project.
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(Collection<? extends IHeaderMatcher>, String) - Constructor for class org.apache.rat.analysis.matchers.OrMatcher: Constructs the matcher from the enclosed matchers.
OrMatcher(String, Collection<? extends IHeaderMatcher>, String) - Constructor for class org.apache.rat.analysis.matchers.OrMatcher: Constructs the matcher with the specified id from the enclosed matchers.
output() - Method in class org.apache.rat.help.Licenses: Output the License information without the version information.
output() - Method in class org.apache.rat.Reporter: Outputs the report using the stylesheet and output specified in the configuraiton.
output(IOSupplier<InputStream>, IOSupplier<OutputStream>) - Method in class org.apache.rat.Reporter: Outputs the report to the specified output useing the optional stylesheet.

P

parallelStream() - Method in class org.apache.rat.utils.ReportingSet
parseCommands(String[], Consumer<Options>) - Static method in class org.apache.rat.OptionCollection: Parses the standard options to create a ReportConfiguration.
parseCommands(String[], Consumer<Options>, boolean) - Static method in class org.apache.rat.OptionCollection: Parses the standard options to create a ReportConfiguration.
printArgumentTypes() - Method in class org.apache.rat.help.Help
printHelp(PrintWriter, String, String, Options, String) - Method in class org.apache.rat.help.AbstractHelp.RatHelpFormatter
printHelp() - Method in class org.apache.rat.help.Licenses: Print the help text with the version information.
printUsage(Options) - Method in class org.apache.rat.help.Help: Print the usage to the specific PrintWriter.
process(Document) - Static method in class org.apache.rat.analysis.TikaProcessor: Process the input document.
process(RatReport, Document) - Method in class org.apache.rat.walker.DirectoryWalker: Process a directory, ignoring any files/directories set to be ignored.
processArgs(ArgumentContext) - Static method in enum org.apache.rat.commandline.Arg: Process the arguments.
processArgs() - Method in class org.apache.rat.commandline.ArgumentContext: Process the arguments specified in this context.
processLogLevel(CommandLine) - Static method in enum org.apache.rat.commandline.Arg: Process the log level setting.
prune(String) - Static method in class org.apache.rat.analysis.matchers.FullTextMatcher: Removes everything except letter or digit from text.
pruned() - Method in interface org.apache.rat.analysis.IHeaders: Gets the pruned header.

R

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: Interface that defines a RatReport.
raw() - Method in interface org.apache.rat.analysis.IHeaders: Gets raw header as found in the document.
read() - Method in class org.apache.rat.analysis.HeaderCheckWorker: Read the input and perform the header check.
read(Reader) - Method in class org.apache.rat.configuration.XMLConfigurationReader: Read xml from a reader.
read(URI...) - Method in class org.apache.rat.configuration.XMLConfigurationReader: Read the uris and extract the DOM information to create new objects.
read(Reader) - Method in class org.apache.rat.header.HeaderMatcher: Deprecated.
read() - Method in class org.apache.rat.header.LineNumberReader: Deprecated.
reader() - Method in class 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
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
readHeader(BufferedReader, int) - Static method in class org.apache.rat.analysis.HeaderCheckWorker: Read the input and perform the header check.
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: Deprecated.
Use new RegexBuilder()
RegexBuilder - Class in org.apache.rat.configuration.builders: A builder for the regex matcher.
RegexBuilder() - Constructor for class org.apache.rat.configuration.builders.RegexBuilder
remove(URI) - Method in class org.apache.rat.Defaults.Builder: Removes a file from the list of configuration files to process.
remove(String) - Method in class org.apache.rat.Defaults.Builder: Removes a file name from the list of configuration files to process.
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
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.
removeApprovedLicenseId(String) - Method in class org.apache.rat.ReportConfiguration: Adds a license family category to the list of approved licenses.
removeApprovedLicenseIds(Collection<String>) - Method in class org.apache.rat.ReportConfiguration: Removes a license family category from the list of approved licenses.
removeIf(Predicate<? super T>) - Method in class org.apache.rat.utils.ReportingSet
removeLicenseCategory(String) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license family category (id) to the list of approved licenses
removeLicenseId(String) - Method in class org.apache.rat.license.LicenseSetFactory: Removes a license ID from the list of approved licenses.
removeLicenses(Predicate<ILicense>) - Method in class org.apache.rat.api.MetaData
renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.rat.help.AbstractHelp.RatHelpFormatter
Report - Class in org.apache.rat: The CLI based configuration object for report generation.
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.
ReportConfiguration - Class in org.apache.rat: A configuration object is used by the front end to invoke the Reporter.
ReportConfiguration() - 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.
ReportConfiguration.Processing - Enum in org.apache.rat: The styles of processing for various categories of documents.
Reporter - Class in org.apache.rat: Class that executes the report as defined in a ReportConfiguration and stores the result for later handling.
Reporter(ReportConfiguration) - Constructor for class org.apache.rat.Reporter: Create the reporter.
ReportFormat - Enum in org.apache.rat.config
ReportingSet<T> - Class in org.apache.rat.utils: A sorted set that reports insertion collisions.
ReportingSet(SortedSet<T>) - Constructor for class org.apache.rat.utils.ReportingSet: Constructs.
ReportingSet.Options - Enum in org.apache.rat.utils: The Options for duplicate processing
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 of this matcher to its initial state in preparation for use with another document scan.
reset() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer
reset() - Method in class org.apache.rat.analysis.matchers.NotMatcher
reset() - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match
reset() - Method in class org.apache.rat.analysis.UnknownLicense
reset() - Static method in enum org.apache.rat.commandline.Arg: Resets the groups in the Args so that they are unused and ready to detect the next set of arguments.
reset() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy
reset() - Method in class org.apache.rat.license.SimpleLicense
resource - Variable in class org.apache.rat.configuration.builders.ChildContainerBuilder: The resource the builders came from if it was read from a resource
retainAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
ROOT - Static variable in class org.apache.rat.configuration.XMLConfig: root of the configuration file
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, String, SortedSet<ILicense>) - Static method in class org.apache.rat.license.LicenseSetFactory: Search a SortedSet of licenses for the matching license id.
search(ILicense, SortedSet<ILicense>) - Static method in class org.apache.rat.license.LicenseSetFactory: Search a SortedSet of licenses for the matching license.
setAddLicenseHeaders(AddLicenseHeaders) - Method in class org.apache.rat.ReportConfiguration: Sets whether RAT should enable, disable, or force the adding of license headers.
setApprovedLicenses(Set<ILicenseFamily>) - Method in class org.apache.rat.api.MetaData: Sets the set of approved licenses.
setArchiveProcessing(ReportConfiguration.Processing) - Method in class org.apache.rat.ReportConfiguration: Sets the archive processing type.
setChild(IHeaderMatcher.Builder, String, String) - Method in class org.apache.rat.config.parameters.Description: Sets the child value in the builder.
setChildren(IHeaderMatcher.Builder, Map<String, String>) - Method in class org.apache.rat.config.parameters.Description: Sets the children of values in the builder.
setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration: Sets the optional copyright message used if RAT is adding license headers.
setDirectoriesToIgnore(IOFileFilter) - Method in class org.apache.rat.ReportConfiguration: Sets the directories to ignore.
setDocumentType(Document.Type) - Method in class org.apache.rat.api.MetaData: Sets the document type.
setDryRun(boolean) - Method in class org.apache.rat.ReportConfiguration: Sets the dry run flag.
setDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.utils.ReportingSet: If set true attempts to duplicate will throw an IllegalArgumentException.
setEnclosed(IHeaderMatcher.Builder) - Method in class org.apache.rat.configuration.builders.NotBuilder: Sets the enclosed matcher.
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.
setFamily(String) - Method in interface org.apache.rat.license.ILicense.Builder: Set the family category for this license.
setFamily(String) - Method in class org.apache.rat.license.SimpleLicense.Builder: Set the family category for this license.
setFamilyCategory(String) - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
setFamilyName(String) - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
setFilesToIgnore(IOFileFilter) - Method in class org.apache.rat.ReportConfiguration: Sets the files name filter for files to ignore.
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.

Set the text to match
setHeaderPattern(Pattern) - Method in class org.apache.rat.header.HeaderBean: Deprecated.

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.configuration.builders.SpdxBuilder: Set the id for the matcher.
setId(String) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the ID of the license.
setId(String) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the ID of the license.
setInstance(Log) - Static method in class org.apache.rat.utils.DefaultLog: Sets the default log instance.
setLevel(Log.Level) - Method in class org.apache.rat.utils.DefaultLog: Sets the level.
setLicenseFamilies(SortedSet<ILicenseFamily>) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the set of license families to use duirng build.
setLicenseFamilies(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.license.SimpleLicense.Builder
setLicenseFamilyCategory(String) - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
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
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: Deprecated.
setMatcher(IHeaderMatcher.Builder) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the matcher from a builder.
setMatcher(IHeaderMatcher) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the matcher.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the matcher from a builder.
setMatcher(IHeaderMatcher) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the matcher.
setMatcherMap(Map<String, IHeaderMatcher>) - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder: Set the Map of matcher ids to matcher instances.
setMediaType(MediaType) - Method in class org.apache.rat.api.MetaData: Sets the defined media type.
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 interface org.apache.rat.license.ILicense.Builder: Sets the name of the license.
setName(String) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the name of the license.
setNote(String) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the notes for the license.
setNote(String) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the notes for the license.
setNotes(String) - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
setOut(IOSupplier<OutputStream>) - Method in class org.apache.rat.ReportConfiguration: Sets the supplier for the output stream.
setOut(File) - Method in class org.apache.rat.ReportConfiguration: Sets the OutputStream supplier to use the specified file.
setOverwrite(boolean) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Set the force flag on this appender.
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: Sets the reportable object.
setResource(String) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder: Reads a text file.
setSampleHeader(String) - Method in class org.apache.rat.api.MetaData: Sets the sample header.
setSimpleText(String) - Method in class org.apache.rat.configuration.builders.TextBuilder: Sets the text to match.
setStandardProcessing(ReportConfiguration.Processing) - Method in class org.apache.rat.ReportConfiguration: Sets the archive processing type.
setStart(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder: Sets the start date.
setStyleSheet(IOSupplier<InputStream>) - Method in class org.apache.rat.ReportConfiguration: Sets the style sheet for custom processing.
setStyleSheet(File) - Method in class org.apache.rat.ReportConfiguration: Sets the style sheet.
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.
setter(Class<?>) - Method in class org.apache.rat.config.parameters.Description: Returns the setter for the component in the specified class.
SimpleLicense - Class in org.apache.rat.license: A simple implementation of ILicense.
SimpleLicense.Builder - Class in org.apache.rat.license
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.
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: Deprecated.
Use new SpdxBuilder()
SpdxBuilder - Class in org.apache.rat.configuration.builders: A builder 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
STANDARD_PROCESSING - Static variable in class org.apache.rat.Defaults: The default STANDARD processing style
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 class org.apache.rat.report.ConfigurationReport
startReport() - Method in interface org.apache.rat.report.RatReport: Signals the start of execution for the report.
startReport(IXmlWriter) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Starts the XML report by writing the standard header into the writer.
stream() - Method in class org.apache.rat.utils.ReportingSet
StyleSheets - Enum in org.apache.rat.commandline: The enumeration of system defined stylesheets.
subSet(T, T) - Method in class org.apache.rat.utils.ReportingSet

T

tailSet(T) - Method in class org.apache.rat.utils.ReportingSet
text() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new TextBuilder()
TextBuilder - Class in org.apache.rat.configuration.builders: Builds a text matcher.
TextBuilder() - Constructor for class org.apache.rat.configuration.builders.TextBuilder
TikaProcessor - Class in org.apache.rat.analysis: A wrapping around the tika processor.
toArray() - Method in class org.apache.rat.utils.ReportingSet
toArray(T[]) - Method in class org.apache.rat.utils.ReportingSet
toCase(CasedString.StringCase) - Method in class org.apache.rat.utils.CasedString: Converts this cased string into a String of another format.
toString() - Method in class org.apache.rat.analysis.matchers.AbstractHeaderMatcher
toString() - Method in class org.apache.rat.api.Document: Representations suitable for logging.
toString() - Method in class org.apache.rat.api.MetaData
toString() - Method in class org.apache.rat.config.parameters.Description
toString(int) - Method in class org.apache.rat.config.parameters.Description: Write a description with indentation.
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.license.SimpleLicense
toString() - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
toString() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
toString() - Method in class org.apache.rat.utils.CasedString: Returns the string representation provided in the constructor.
toString() - Method in class org.apache.rat.VersionInfo: Default string representation of the implementation information from the package.
typePredicate(ComponentType) - Static method in class org.apache.rat.config.parameters.Description: A predicate to filter Descriptions by component type.

U

unapprovedLicenses() - Method in class org.apache.rat.api.MetaData: Gets the stream of unapproved licenses that have been matched.
UNKNOWN_CATEGORY - Static variable in interface org.apache.rat.license.ILicenseFamily: The category for unknown licenses
UnknownLicense - Class in org.apache.rat.analysis: An ILicense implementation that represents an unknown license.
useMsg(String) - Static method in class org.apache.rat.commandline.Arg.StdMsgs: Gets the standard "use instead" message for the specific name.

V

validate(Consumer<String>) - Method in class org.apache.rat.ReportConfiguration: Validates that the configuration is valid.
valueOf(String) - Static method in enum org.apache.rat.api.Document.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.commandline.Arg: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.commandline.StyleSheets: 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.parameters.ComponentType: 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.report.claim.ClaimStatistic.Counter: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.ReportConfiguration.Processing: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.utils.CasedString.StringCase: 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.api.Document.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.commandline.Arg: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.commandline.StyleSheets: 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.parameters.ComponentType: 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.report.claim.ClaimStatistic.Counter: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.rat.ReportConfiguration.Processing: 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.CasedString.StringCase: 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.
versionInfo - Variable in class org.apache.rat.help.AbstractHelp
VersionInfo - Class in org.apache.rat: A formatter for Package information about a class.
VersionInfo() - Constructor for class org.apache.rat.VersionInfo: Constructor that uses the VersionInfo package for information.
VersionInfo(Class<?>) - Constructor for class org.apache.rat.VersionInfo: Constructor for a specific class.

W

Walker - Class in org.apache.rat.walker: Abstract walker.
Walker(Document, FilenameFilter) - Constructor for class org.apache.rat.walker.Walker: Creates the walker
warn(Object) - Method in interface org.apache.rat.utils.Log: Write a message at WARN level.
warn(Object, Throwable) - Method in interface org.apache.rat.utils.Log: Write a warn message and report throwable stack trace.
write(Writer) - Method in class org.apache.rat.configuration.XMLConfigurationWriter: Writes the configuration to the specified writer.
write(IXmlWriter) - Method in class org.apache.rat.configuration.XMLConfigurationWriter: Writes the configuration to an IXmlWriter instance.
write(int) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
write(byte[], int, int) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
write(byte[]) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream

X

XMLConfig - Class in org.apache.rat.configuration: Configuration definitions for XMLConfiguration reader and writer.
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.
XMLConfigurationWriter - Class in org.apache.rat.configuration: Writes the XML configuration file format.
XMLConfigurationWriter(ReportConfiguration) - Constructor for class org.apache.rat.configuration.XMLConfigurationWriter: Constructor
XmlReportFactory - Class in org.apache.rat.report.xml: A factory to create reports from a writer and a configuration.
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 L M N O P R S T U V W X