Index (Apache Creadur RAT 0.17 API)

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

A

ABSENCE - Enum constant in enum org.apache.rat.ReportConfiguration.Processing: List all present licenses and unknown licenses
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: Abstract base implementation of RatReport.
AbstractClaimReporter() - Constructor for class org.apache.rat.report.claim.AbstractClaimReporter
AbstractFileProcessorBuilder - Class in org.apache.rat.config.exclusion.fileProcessors: Creates a List of MatcherSets that represent the inclusions and exclusions of this file processor.
AbstractFileProcessorBuilder(String, Iterable<String>, boolean) - Constructor for class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Constructor for multiple comment prefixes.
AbstractFileProcessorBuilder(String, String, boolean) - Constructor for class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Constructor for single comment prefix
AbstractFileProcessorBuilder(String, Predicate<String>, boolean) - Constructor for class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Constructor for single comment prefix
AbstractFileProcessorBuilder.LevelBuilder - Class in org.apache.rat.config.exclusion.fileProcessors: Manages the merging of MatcherSets for the specified level.
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: The base class to perform Help processing for programs.
AbstractHelp() - Constructor for class org.apache.rat.help.AbstractHelp: Base class to perform help output.
AbstractHelp.RatHelpFormatter - Class in org.apache.rat.help: Provides help for formatting text.
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.
AbstractOption - Class in org.apache.rat.documentation.options: Abstract class that provides the framework for UI-specific RAT options.
AbstractRatMojo - Class in org.apache.rat.mp: Abstract base class for Mojos, which are running Rat.
AbstractRatMojo() - Constructor for class org.apache.rat.mp.AbstractRatMojo
AbstractReport - Class in org.apache.rat.report: Deprecated.
use RatReport directly.
AbstractReport() - Constructor for class org.apache.rat.report.AbstractReport: Deprecated.
add(File) - Method in class org.apache.rat.Defaults.Builder: Adds a configuration file to be read.
add(String) - Method in class org.apache.rat.Defaults.Builder: Adds the name of a configuration file to be read.
add(URI) - Method in class org.apache.rat.Defaults.Builder: Adds a URL to a configuration file to be read.
add(IHeaderMatcher) - Method in class org.apache.rat.anttasks.License: Deprecated.
add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.All: Deprecated.
add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.Any: Deprecated.
add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.License: Deprecated.
add(IHeaderMatcher.Builder) - Method in class org.apache.rat.anttasks.Not: Deprecated.
add(MatcherSet) - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder.LevelBuilder: Adds a MatcherSet to this level.
add(LicenseSetFactory) - Method in class org.apache.rat.license.LicenseSetFactory
add(ResourceCollection) - Method in class org.apache.rat.anttasks.Report: Adds resources that will be checked.
add(Document) - Method in class org.apache.rat.configuration.XMLConfigurationReader: Merge the new document into the document that this reader processes is building.
add(T) - Method in class org.apache.rat.utils.ReportingSet
addAddApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use licensesFamiliesApproved child element
addAll(Collection<? extends T>) - Method in class org.apache.rat.utils.ReportingSet
addAllIfNotPresent(Collection<? extends T>) - Method in class org.apache.rat.utils.ReportingSet
addApprovedLicenseCategories(Collection<String>) - Method in class org.apache.rat.ReportConfiguration: Adds a collection of license family categories to the set of approved license names.
addApprovedLicenseCategory(String) - Method in class org.apache.rat.ReportConfiguration: Adds a license family category (id) to the list of approved licenses
addApprovedLicenseCategory(ILicenseFamily) - Method in class org.apache.rat.ReportConfiguration: Adds an ILicenseFamily to the list of approved licenses.
addApprovedLicenseId(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.
addApprovedLicenseIds(Collection<String>) - Method in class org.apache.rat.ReportConfiguration: Adds a collection of license family categories to the set of approved license names.
addArg(String, String) - Method in class org.apache.rat.anttasks.BaseAntTask: Add a value to the key in the argument list.
addArg(String, String) - Method in class org.apache.rat.plugin.BaseRatMojo: Add a value to the key in the argument list.
addArg(String, String[]) - Method in class org.apache.rat.anttasks.BaseAntTask: Add values to the key in the argument list.
addArg(String, String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Add values to the key in the argument list.
addBuilder(String, String) - Static method in class org.apache.rat.configuration.MatcherBuilderTracker: Adds a builder to the tracker.
addConfiguredCntr(BaseAntTask.Cntr) - Method in class org.apache.rat.anttasks.BaseAntTask.CounterMax
addConfiguredCntr(BaseAntTask.Cntr) - Method in class org.apache.rat.anttasks.BaseAntTask.CounterMin
addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.Exclude
addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.Include
addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExclude
addConfiguredExpr(BaseAntTask.Expr) - Method in class org.apache.rat.anttasks.BaseAntTask.InputInclude
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.Config
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExclude
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.InputInclude
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesApproved
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesDenied
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.Licenses
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesApproved
addConfiguredFileset(FileSet) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesDenied
addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesApproved
addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicenseFamiliesDenied
addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesApproved
addConfiguredLst(BaseAntTask.Lst) - Method in class org.apache.rat.anttasks.BaseAntTask.LicensesDenied
addConfiguredStd(BaseAntTask.Std) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExclude
addConfiguredStd(BaseAntTask.Std) - Method in class org.apache.rat.anttasks.BaseAntTask.InputExcludeParsedScm
addConfiguredStd(BaseAntTask.Std) - Method in class org.apache.rat.anttasks.BaseAntTask.InputInclude
addEnclosed(Collection<IHeaderMatcher.Builder>) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder: Adds a collection of builders to the list of child builders.
addEnclosed(IHeaderMatcher.Builder) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder: Adds a builder to the list of builders.
addExcluded(DocumentNameMatcher) - Method in class org.apache.rat.config.exclusion.MatcherSet.Builder: Adds specified DocumentNameMatcher to the excluded matchers.
addExcluded(DocumentName, Set<String>) - Method in class org.apache.rat.config.exclusion.MatcherSet.Builder: Adds excluded file names from the specified document.
addExcludedCollection(StandardCollection) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Excludes the files/directories specified by a StandardCollection.
addExcludedCollection(StandardCollection) - Method in class org.apache.rat.ReportConfiguration: Excludes a StandardCollection of patterns.
addExcludedFileProcessor(StandardCollection) - Method in class org.apache.rat.ReportConfiguration: Excludes the file processor defined in the StandardCollection.
addExcludedFilter(FileFilter) - Method in class org.apache.rat.ReportConfiguration: Excludes files that match a FileFilter.
addExcludedMatcher(DocumentNameMatcher) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add the DocumentNameMatcher as an excluded pattern.
addExcludedMatcher(DocumentNameMatcher) - Method in class org.apache.rat.ReportConfiguration: Excludes files that match a DocumentNameMatcher.
addExcludedPatterns(Iterable<String>) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add the patterns from collections of patterns as excluded patterns.
addExcludedPatterns(Iterable<String>) - Method in class org.apache.rat.ReportConfiguration: Excludes files that match the pattern.
addFamilies(Collection<ILicenseFamily>) - Method in class org.apache.rat.ReportConfiguration: Adds multiple families to the list of license families.
addFamily(Family) - Method in class org.apache.rat.anttasks.Report: Deprecated.
Create a custom configuration file and use the config option.
addFamily(ILicenseFamily) - 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.license.LicenseSetFactory: 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.
addFileProcessor(StandardCollection) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add the file processor from a StandardCollection.
addIfNotPresent(T) - Method in class org.apache.rat.utils.ReportingSet: Adds the item if it is not present.
addIncluded(DocumentNameMatcher) - Method in class org.apache.rat.config.exclusion.MatcherSet.Builder: Adds specified DocumentNameMatcher to the included matchers.
addIncluded(DocumentName, Set<String>) - Method in class org.apache.rat.config.exclusion.MatcherSet.Builder: Adds included file names from the specified document.
addIncludedCollection(StandardCollection) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add the patterns from the StandardCollection as included patterns.
addIncludedCollection(StandardCollection) - Method in class org.apache.rat.ReportConfiguration: Adds the patterns from the standard collection as included patterns.
addIncludedFilter(FileFilter) - Method in class org.apache.rat.ReportConfiguration: Adds the fileFilter to filter files that should be included, this overrides any exclusion of the same files.
addIncludedMatcher(DocumentNameMatcher) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add a DocumentNameMatcher to the collection of file/directory patterns to ignore.
addIncludedPatterns(Iterable<String>) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add the Iterable of strings to the collection of file/directory patters to ignore.
addIncludedPatterns(Iterable<String>) - Method in class org.apache.rat.ReportConfiguration: Add file patterns that are to be included.
addLicense(License) - Method in class org.apache.rat.anttasks.Report: Deprecated.
Create a custom configuration file and use the config option.
addLicense(ILicense) - 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.license.LicenseSetFactory: Adds a license to the list of licenses.
addLicense(ILicense.Builder) - Method in class org.apache.rat.ReportConfiguration: Adds a license to the list of licenses.
AddLicenseHeaders - Enum in org.apache.rat.config: Value of addLicenseHeaders configuration option.
AddLicenseHeaders() - Constructor for class org.apache.rat.anttasks.Report.AddLicenseHeaders: Deprecated.
AddLicenseHeaders(String) - Constructor for class org.apache.rat.anttasks.Report.AddLicenseHeaders: Deprecated.
addLicenses(URI) - Method in interface org.apache.rat.configuration.LicenseReader: Adds a 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 a URI to the set of files to be read.
addMatchers(URI) - Method in class org.apache.rat.configuration.XMLConfigurationReader
addNotes(String) - Method in class org.apache.rat.anttasks.License: Deprecated.
addRemoveApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use licensesFamiliesDenied child element
addRemoveApprovedLicense(String[]) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use licenseFamilyDenied element
addReportable(IReportable) - Method in class org.apache.rat.walker.IReportableListWalker.Builder: Add a reportable to the list of reportables to run.
addSource(File) - Method in class org.apache.rat.ReportConfiguration: Adds a file as a source of files to scan.
addSource(IReportable) - Method in class org.apache.rat.ReportConfiguration: Adds a Reportable as a source of files to scan.
addStylesheet(Resource) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use BaseAntTask.setStylesheet(String)
addStyleSheet(Resource) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use BaseAntTask.setOutputStyle(String)
addText(String) - Method in class org.apache.rat.anttasks.BaseAntTask.TxtValue
addText(String) - Method in class org.apache.rat.anttasks.Regex: Deprecated.
addText(String) - Method in class org.apache.rat.anttasks.Spdx: Deprecated.
addText(String) - Method in class org.apache.rat.anttasks.Text: Deprecated.
addTo(U) - Method in class org.apache.rat.utils.ExtendedIterator: A method to add the remaining elements in the iterator an arbitrary collection.
all() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new AllBuilder()
All - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
All - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
All() - Constructor for class org.apache.rat.anttasks.All: Deprecated.
All() - Constructor for class org.apache.rat.mp.All: Deprecated.
ALL - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: All the standard excludes combined.
ALL - Enum constant in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter: All defined licenses are returned.
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.DocumentAnalyser: Analyse the specified document.
AnalyserFactory - Class in org.apache.rat.analysis: Creates default analysers.
and(Collection<DocumentNameMatcher>) - Static method in class org.apache.rat.document.DocumentNameMatcher: Performs a logical AND across the collection of matchers.
and(DocumentNameMatcher...) - Static method in class org.apache.rat.document.DocumentNameMatcher: Performs a logical AND across the collection of matchers.
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 a unique random id and the enclosed collection.
andThen(Iterator<X>) - Method in class org.apache.rat.utils.ExtendedIterator: Chains the other iterator to the end of this one.
ANT_HANDLER_PREFIX - Static variable in class org.apache.rat.config.exclusion.plexus.SelectorUtils
AntDocumentation - Class in org.apache.rat.tools: A simple tool to convert CLI options into an Ant report base class.
AntGenerator - Class in org.apache.rat.tools: A simple tool to convert CLI options into an Ant report base class.
AntGenerator.GenerateType - Class in org.apache.rat.tools
AntHelpFormatter() - Constructor for class org.apache.rat.anttasks.Help.AntHelpFormatter
AntOption - Class in org.apache.rat.documentation.options: A class that wraps the CLI option and provides Ant specific values.
AntOption(Option) - Constructor for class org.apache.rat.documentation.options.AntOption: Constructor.
AntOption.ExampleGenerator - Class in org.apache.rat.documentation.options: An example code generator for this AntOption.
antOptions() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a map client option name to Ant Option.
any() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new AnyBuilder()
Any - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Any - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Any() - Constructor for class org.apache.rat.anttasks.Any: Deprecated.
Any() - Constructor for class org.apache.rat.mp.Any: Deprecated.
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.
apply(String) - Method in class org.apache.rat.commandline.Converters.FileConverter: Applies the conversion function to the specified file name.
APPROVAL - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The approval flag
ApprovalFilter() - Constructor for class org.apache.rat.anttasks.Report.ApprovalFilter: Deprecated.
ApprovalFilter(String) - Constructor for class org.apache.rat.anttasks.Report.ApprovalFilter: Deprecated.
APPROVED - Enum constant in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter: Only approved licenses are returned.
APPROVED - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of approved files
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.
approveLicenseCategory(String) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license family category (id) to the list of approved licenses
approveLicenseId(String) - Method in class org.apache.rat.license.LicenseSetFactory: Adds a license family category (id) to the list of approved licenses
aptEscape(String) - Method in class org.apache.rat.documentation.velocity.RatTool: Escapes a string for APT (almost plain text).
ARCH - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an ARCH source code control based tool.
ARCHIVE - Enum constant in enum org.apache.rat.api.Document.Type: An archive type document.
ARCHIVE_PROCESSING - Static variable in class org.apache.rat.Defaults: The default ARCHIVES processing style.
ArchiveEntryDocument - Class in org.apache.rat.document: A Document that wraps an Archive entry.
ArchiveEntryDocument(ArchiveEntryName, byte[], DocumentNameMatcher) - Constructor for class org.apache.rat.document.ArchiveEntryDocument: Creates an Archive entry.
ArchiveEntryName - Class in org.apache.rat.document
ArchiveEntryName(DocumentName, String) - Constructor for class org.apache.rat.document.ArchiveEntryName
ARCHIVES - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of archive files
ArchiveWalker - Class in org.apache.rat.walker: Walks various kinds of archives files.
ArchiveWalker(Document) - Constructor for class org.apache.rat.walker.ArchiveWalker: Constructs a walker.
arg() - Method in enum org.apache.rat.commandline.StyleSheets: Gets the name of the xslt file.
Arg - Enum in org.apache.rat.commandline: An enumeration of options.
ARG - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A generic argument.
Arg.StdMsgs - Class in org.apache.rat.commandline: Standard messages used in descriptions.
argCount() - Method in class org.apache.rat.documentation.options.AbstractOption: Returns the number of arguments.
args - Variable in class org.apache.rat.anttasks.BaseAntTask: A map of CLI-based arguments to values.
args - Variable in class org.apache.rat.plugin.BaseRatMojo: A map of CLI-based arguments to values.
args() - Method in class org.apache.rat.anttasks.BaseAntTask: Gets the list of arguments prepared for the CLI code to parse.
args() - Method in class org.apache.rat.plugin.BaseRatMojo: Gets the list of arguments prepared for the CLI code to parse.
ArgumentContext - Class in org.apache.rat.commandline: Provides the context necessary to process various arguments.
ArgumentContext(File, CommandLine) - Constructor for class org.apache.rat.commandline.ArgumentContext: Creates a context with an empty configuration.
ArgumentContext(File, ReportConfiguration, CommandLine) - Constructor for class org.apache.rat.commandline.ArgumentContext: Creates a context with the specified configuration.
argumentType - Variable in class org.apache.rat.documentation.options.AbstractOption: The argument type for this option
argumentTypes() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of argument types.
ArgumentTypes - Class in org.apache.rat.tools: A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.
asFile() - Method in class org.apache.rat.document.ArchiveEntryName
asFile() - Method in class org.apache.rat.document.DocumentName: Creates a file from the document name.
asFileFilter(DocumentName, DocumentNameMatcher) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Create a FileFilter from a PathMatcher.
asIterable(File, String) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Creates an iterable of Strings from a file of patterns.
asIterable(File, Predicate<String>) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Creates an iterable of Strings from a file of patterns.
asIterator(File, Predicate<String>) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Creates an iterator of Strings from a file of patterns.
asMatcherSet() - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder.LevelBuilder: Constructs the MatcherSet for this level.
asPath() - Method in class org.apache.rat.document.ArchiveEntryName
asPath() - Method in class org.apache.rat.document.DocumentName: Creates a path from the document name.
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.
asWriter(Log.Level) - 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_RESOURCE - Static variable in class org.apache.rat.configuration.XMLConfig: resource file name attribute name.
attribute(CharSequence, CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Writes an attribute of an element.
attribute(CharSequence, CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Writes an attribute of an element.
attribute(String, String...) - Method in class org.apache.rat.tools.xsd.XsdWriter: Writes the attributes
ATTRIBUTE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An attribute

B

BaseAntTask - Class in org.apache.rat.anttasks: Generated class to provide Ant support for standard RAT command line options.
BaseAntTask() - Constructor for class org.apache.rat.anttasks.BaseAntTask
BaseAntTask.Cntr - Class in org.apache.rat.anttasks
BaseAntTask.Config - Class in org.apache.rat.anttasks
BaseAntTask.CounterMax - Class in org.apache.rat.anttasks
BaseAntTask.CounterMin - Class in org.apache.rat.anttasks
BaseAntTask.Exclude - Class in org.apache.rat.anttasks
BaseAntTask.Expr - Class in org.apache.rat.anttasks
BaseAntTask.Filename - Class in org.apache.rat.anttasks
BaseAntTask.Include - Class in org.apache.rat.anttasks
BaseAntTask.InputExclude - Class in org.apache.rat.anttasks
BaseAntTask.InputExcludeParsedScm - Class in org.apache.rat.anttasks
BaseAntTask.InputInclude - Class in org.apache.rat.anttasks
BaseAntTask.LicenseFamiliesApproved - Class in org.apache.rat.anttasks
BaseAntTask.LicenseFamiliesDenied - Class in org.apache.rat.anttasks
BaseAntTask.Licenses - Class in org.apache.rat.anttasks
BaseAntTask.LicensesApproved - Class in org.apache.rat.anttasks
BaseAntTask.LicensesDenied - Class in org.apache.rat.anttasks
BaseAntTask.Lst - Class in org.apache.rat.anttasks
BaseAntTask.Std - Class in org.apache.rat.anttasks
BaseAntTask.TxtValue - Class in org.apache.rat.anttasks
BaseLicense - Class in org.apache.rat.analysis.license: Deprecated.
BaseLicense() - Constructor for class org.apache.rat.analysis.license.BaseLicense: Deprecated.
BaseRatMojo - Class in org.apache.rat.plugin: Generated class to provide Maven support for standard RAT command line options
BaseRatMojo() - Constructor for class org.apache.rat.plugin.BaseRatMojo
BAZAAR - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Bazaar source code control based tool.
BazaarIgnoreBuilder - Class in org.apache.rat.config.exclusion.fileProcessors: A processor for .bzrignore files.
BazaarIgnoreBuilder() - Constructor for class org.apache.rat.config.exclusion.fileProcessors.BazaarIgnoreBuilder: Constructor.
BINARIES - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of binary files
BINARY - Enum constant in enum org.apache.rat.api.Document.Type: A binary file.
BITKEEPER - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Bitkeeper source code control based tool.
build() - Method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Build the IHeaderMatcher.
build() - Method in class org.apache.rat.anttasks.All: Deprecated.
build() - Method in class org.apache.rat.anttasks.Any: Deprecated.
build() - Method in class org.apache.rat.anttasks.Copyright: Deprecated.
build() - Method in class org.apache.rat.anttasks.Family: Deprecated.
build() - Method in class org.apache.rat.anttasks.Not: Deprecated.
build() - Method in class org.apache.rat.anttasks.Regex: Deprecated.
build() - Method in class org.apache.rat.anttasks.Spdx: Deprecated.
build() - Method in class org.apache.rat.anttasks.Text: Deprecated.
build() - Method in class org.apache.rat.config.exclusion.MatcherSet.Builder: Builds a MatcherSet.
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 class org.apache.rat.document.DocumentName.Builder: Build a DocumentName from this builder.
build() - Method in interface org.apache.rat.license.ILicense.Builder: Builds the license.
build() - Method in class org.apache.rat.license.ILicenseFamily.Builder: Builds the defined license family.
build() - Method in class org.apache.rat.license.SimpleLicense.Builder
build() - Method in class org.apache.rat.mp.All: Deprecated.
build() - Method in class org.apache.rat.mp.Any: Deprecated.
build() - Method in class org.apache.rat.mp.Copyright: Deprecated.
build() - Method in class org.apache.rat.mp.Family: Deprecated.
build() - Method in class org.apache.rat.mp.Not: Deprecated.
build() - Method in class org.apache.rat.walker.IReportableListWalker.Builder: Build the reportable.
build(Object) - Static method in class org.apache.rat.config.parameters.DescriptionBuilder: Create the description for the object.
build(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.anttasks.License: Deprecated.
build(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.mp.License: Deprecated.
build(DocumentName) - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Builder the list of MatcherSet that define the inclusions/exclusions for the file processor.
BUILD_PARAMETER - Enum constant in enum org.apache.rat.config.parameters.ComponentType: A parameter that is supplied by the environment.
builder() - Static method in class org.apache.rat.Defaults: Gets a builder for a Defaults object.
builder() - Static method in class org.apache.rat.document.DocumentName: Creates a Builder with the default file system info.
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(File) - Static method in class org.apache.rat.document.DocumentName: Creates a builder from a File.
builder(FileSystem) - Static method in class org.apache.rat.document.DocumentName: Creates a builder for the specified file system.
builder(DocumentName) - Static method in class org.apache.rat.document.DocumentName: Creates a builder from a document name.
builder(DocumentName) - Static method in class org.apache.rat.walker.IReportableListWalker: Create a builder for the list walker.
builder(DocumentName.FSInfo) - Static method in class org.apache.rat.document.DocumentName: Creates a builder with the specified FSInfo instance.
Builder() - Constructor for class org.apache.rat.config.exclusion.MatcherSet.Builder
Builder() - Constructor for class org.apache.rat.license.ILicenseFamily.Builder
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

CAMEL - Enum constant in enum org.apache.rat.utils.CasedString.StringCase: Camel case tags strings like 'CamelCase' or 'camelCase'.
canGenerateReport() - Method in class org.apache.rat.mp.RatReportMojo
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 interface org.apache.rat.report.xml.writer.IXmlWriter: Writes CDATA content.
cdata(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter
check(ReportConfiguration) - Method in class org.apache.rat.mp.RatCheckMojo
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
CHOICE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A choice
ClaimAggregator - Class in org.apache.rat.report.claim: The aggregator is used to create a numerical statistic of claims.
ClaimAggregator(ClaimStatistic) - Constructor for class org.apache.rat.report.claim.ClaimAggregator: Constructor.
ClaimReporterMultiplexer - Class in org.apache.rat.report.claim: Executes a RatReport that multiplexes the running of multiple RatReports
ClaimReporterMultiplexer(IXmlWriter, boolean, DocumentAnalyser, List<? extends RatReport>) - Constructor for class org.apache.rat.report.claim.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
ClaimValidator - Class in org.apache.rat.config.results: Validates the ClaimStatistic results meet the specified requirements.
ClaimValidator() - Constructor for class org.apache.rat.config.results.ClaimValidator: Constructor.
ClaimValidatorReport - Class in org.apache.rat.report.claim: A RatReport that publishes the results of the ClaimValidator.
ClaimValidatorReport(IXmlWriter, ClaimStatistic, ReportConfiguration) - Constructor for class org.apache.rat.report.claim.ClaimValidatorReport: Constructor.
cleanup(String) - Method in class org.apache.rat.documentation.options.AbstractOption: Replaces CLI pattern options with implementation specific pattern options.
cleanupName() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets this option's cleaned up name.
cleanupName(Option) - Method in class org.apache.rat.documentation.options.AbstractOption: Provide means to wrap the given option depending on the UI-specific option implementation.
cleanupName(Option) - Method in class org.apache.rat.documentation.options.AntOption
cleanupName(Option) - Method in class org.apache.rat.documentation.options.CLIOption
cleanupName(Option) - Method in class org.apache.rat.documentation.options.MavenOption
clear() - Method in class org.apache.rat.utils.ReportingSet
CLIOption - Class in org.apache.rat.documentation.options
CLIOption(Option) - Constructor for class org.apache.rat.documentation.options.CLIOption
cliOptions() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a map client option name to CLI Option.
close() - Method in class org.apache.rat.report.xml.writer.XmlWriter
close() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream: Does not actually close the delegate.
close(XsdWriter.Type) - Method in class org.apache.rat.tools.xsd.XsdWriter: Closes (Ends) the element for the type.
closeDocument() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Closes all pending elements.
closeDocument() - Method in class org.apache.rat.report.xml.writer.XmlWriter: Closes all pending elements.
closeElement() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Closes the last element written.
closeElement() - Method in class org.apache.rat.report.xml.writer.XmlWriter: Closes the last element written.
closeElement() - Method in class org.apache.rat.report.xml.XmlElements: Closes the currently open element.
closeElement(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Closes all open elements back to and including the named element.
closeElement(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Closes back to and including the last instance of the specified element name.
closeReport() - Method in class org.apache.rat.mp.RatReportMojo: Actions when closing the report.
Cntr() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Cntr
comment(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Writes a comment
comment(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter
COMMENT_PREFIXES - Static variable in class org.apache.rat.config.exclusion.ExclusionUtils: The list of comment prefixes that are used to filter comment lines.
commentFilter - Variable in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: The predicate that will return false for any comment line in the file.
commentFilter(Iterable<String>) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Creates predicate that filters out comment and blank lines.
commentFilter(String) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Creates predicate that filters out comment and blank lines.
comparator() - Method in class org.apache.rat.utils.ReportingSet
compareTo(Document) - Method in class org.apache.rat.api.Document
compareTo(DocumentName) - Method in class org.apache.rat.document.DocumentName
compareTo(DocumentName.FSInfo) - Method in class org.apache.rat.document.DocumentName.FSInfo
compareTo(ILicense) - Method in interface org.apache.rat.license.ILicense
compareTo(ILicenseFamily) - Method in interface org.apache.rat.license.ILicenseFamily
COMPLEX - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A complex type
COMPLEX_CONTENT - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A complex type
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.
CONFIGURATION - Enum constant in enum org.apache.rat.commandline.Arg: Group of options that read a configuration file
CONFIGURATION_NO_DEFAULTS - Enum constant in enum org.apache.rat.commandline.Arg: Group of options that skip the default configuration file
ConfigurationException - Exception in org.apache.rat: An exception thrown when there is an issue with the configuration.
ConfigurationException(String) - Constructor for exception org.apache.rat.ConfigurationException
ConfigurationException(String, Throwable) - Constructor for exception org.apache.rat.ConfigurationException
ConfigurationException(Throwable) - Constructor for exception org.apache.rat.ConfigurationException
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 interface org.apache.rat.report.xml.writer.IXmlWriter: Writes content.
content(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter
convertedFrom() - Method in class org.apache.rat.documentation.options.AntOption: Gets the set of options that are mapped to this option.
Converters - Class in org.apache.rat.commandline: Customized converters for Arg processing.
Converters.FileConverter - Class in org.apache.rat.commandline: A converter that can handle relative or absolute files.
convertSeparator(String, String, String) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Tokenizes the string based on the directory separator.
copyright() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new CopyrightBuilder()
Copyright - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Copyright - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Copyright() - Constructor for class org.apache.rat.anttasks.Copyright: Deprecated.
Copyright() - Constructor for class org.apache.rat.mp.Copyright: Deprecated.
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.

The matching is done case-insensitive

Example supported Copyright header lines, using copyright owner "FooBar" Copyright 2010 FooBar. Copyright 2010-2012 FooBar. copyright 2012 foobar
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.
COUNT - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: A counter
COUNTER_CONVERTER - Static variable in class org.apache.rat.commandline.Converters: Converts the Converter pattern into a Converter, count pair.
COUNTER_MAX - Enum constant in enum org.apache.rat.commandline.Arg: Option to specify an acceptable number of various counters.
COUNTER_MIN - Enum constant in enum org.apache.rat.commandline.Arg: Option to specify an acceptable number of various counters.
COUNTERPATTERN - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A Counter pattern name
create(String) - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory: Creates the SPDX matcher.
create(Iterator<T>) - Static method in class org.apache.rat.utils.ExtendedIterator: Answer an ExtendedIterator returning the elements of it.
create(Stream<T>) - Static method in class org.apache.rat.utils.ExtendedIterator: Answer an ExtendedIterator wrapped round a Stream.
createConfig() - Method in class org.apache.rat.anttasks.BaseAntTask: File names for system configuration.
createConfiguredAnalyser(ReportConfiguration) - Static method in class org.apache.rat.analysis.AnalyserFactory: Creates a DocumentAnalyser from the report configuration.
createCounterMax() - Method in class org.apache.rat.anttasks.BaseAntTask: The acceptable maximum number for the specified counter.
createCounterMin() - Method in class org.apache.rat.anttasks.BaseAntTask: The minimum number for the specified counter.
createDefault() - Static method in class org.apache.rat.utils.DefaultLog: Creates a new instance of the default log.
createExclude() - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.
createInclude() - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.
createInputExclude() - Method in class org.apache.rat.anttasks.BaseAntTask: Excludes files matching <Expression>.
createInputExcludeParsedScm() - Method in class org.apache.rat.anttasks.BaseAntTask: Parse SCM based exclusion files to exclude specified files and directories.
createInputInclude() - Method in class org.apache.rat.anttasks.BaseAntTask: Includes files matching <Expression>.
createLicenseFamiliesApproved() - Method in class org.apache.rat.anttasks.BaseAntTask: A comma separated list of approved license family IDs.
createLicenseFamiliesDenied() - Method in class org.apache.rat.anttasks.BaseAntTask: A comma separated list of denied License family IDs.
createLicenses() - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use <config> instead.
createLicensesApproved() - Method in class org.apache.rat.anttasks.BaseAntTask: A comma separated list of approved License IDs.
createLicensesDenied() - Method in class org.apache.rat.anttasks.BaseAntTask: A comma separated list of denied License IDs.
createMatcher() - Method in interface org.apache.rat.config.exclusion.MatcherSet: Creates a DocumentNameMatcher from an iterable of matcher sets.
createMultiplexer(DocumentAnalyser...) - Static method in class org.apache.rat.analysis.AnalyserFactory: Creates an analyser that calls each of the provided analysers in order.
createName(String) - Static method in class org.apache.rat.anttasks.BaseAntTask
createName(String) - Static method in class org.apache.rat.plugin.BaseRatMojo: Creates a Maven name from a long option.
createName(Option) - Static method in class org.apache.rat.documentation.options.AntOption
createName(Option) - Static method in class org.apache.rat.documentation.options.CLIOption
createNoRemove(Iterator<T>) - Static method in class org.apache.rat.utils.ExtendedIterator: Answer an ExtendedIterator wrapped round it, which does not permit .remove() even if it does.
createPadding(int) - Static method in class org.apache.rat.help.AbstractHelp: Create a padding.
createPolicy(Predicate<ILicense>) - Static method in class org.apache.rat.analysis.AnalyserFactory: Creates an analyser that adds the approved license predicate to the document metadata.
createStandardReport(IXmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a RatReport from the arguments.
CVS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a CVS source code control based tool.
CVSIgnoreBuilder - Class in org.apache.rat.config.exclusion.fileProcessors: A file processor for the .csvignore file.
CVSIgnoreBuilder() - Constructor for class org.apache.rat.config.exclusion.fileProcessors.CVSIgnoreBuilder: The constructor.

D

DARCS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a DARCS source code control based tool.
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.
DEBUG - Enum constant in enum org.apache.rat.utils.Log.Level: Log debug only.
decompose(DocumentName) - Method in class org.apache.rat.document.DocumentNameMatcher: Decomposes the matcher execution against the candidate.
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.
DefaultLog - Class in org.apache.rat.utils: A default implementation of Log that writes to System.out and System.err.
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: Gets the default value for this 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.config.exclusion.StandardCollection
desc() - Element in annotation type org.apache.rat.config.parameters.ConfigComponent: The description of the component.
desc() - Method in enum org.apache.rat.ReportConfiguration.Processing: Gets the description of the processing type.
description() - Method in enum org.apache.rat.OptionCollection.ArgumentType
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
DESCRIPTION - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: A description
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.
DIR - Enum constant in enum org.apache.rat.commandline.Arg: Stop processing an input stream and declare an input file.
directorySeparator() - Method in class org.apache.rat.document.DocumentName.Builder: Get the directory separator for this builder.
DirectoryWalker - Class in org.apache.rat.walker: Walks directories.
DirectoryWalker(Document) - Constructor for class org.apache.rat.walker.DirectoryWalker: Constructs a directory walker.
DIRORARCHIVE - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A directory or archive.
dirSeparator() - Method in class org.apache.rat.document.DocumentName.FSInfo: Gets the directory separator.
displayName() - Method in enum org.apache.rat.report.claim.ClaimStatistic.Counter: Display name is capitalized and any underscores are replaced by spaces.
document(Document) - Method in class org.apache.rat.report.xml.XmlElements: Creates a document element with attributes.
Document - Class in org.apache.rat.api: The representation of a document being scanned.
Document(DocumentName, DocumentNameMatcher) - Constructor for class org.apache.rat.api.Document: Creates an instance.
DOCUMENT_TYPE - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A document type entry
DOCUMENT_TYPES - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of distinct document types
Document.Type - Enum in org.apache.rat.api: An enumeration of document types.
DocumentAnalyser - Interface in org.apache.rat.document: Analyses Documents.
documentation() - Method in enum org.apache.rat.api.EnvVar: Gets the documentation for this EnvVar.
Documentation - Class in org.apache.rat.tools: Generates text based documentation for Licenses, LicenceFamilies, and Matchers.
DocumentName - Class in org.apache.rat.document: The name for a document.
DocumentName.Builder - Class in org.apache.rat.document: The Builder for a DocumentName.
DocumentName.FSInfo - Class in org.apache.rat.document: The file system information needed to process document names.
DocumentNameMatcher - Class in org.apache.rat.document: Matches document names.
DocumentNameMatcher(FileFilter) - Constructor for class org.apache.rat.document.DocumentNameMatcher: Creates a DocumentNameMatcher from a File filter.
DocumentNameMatcher(String, FileFilter) - Constructor for class org.apache.rat.document.DocumentNameMatcher: Creates a DocumentNameMatcher from a File filter.
DocumentNameMatcher(String, Predicate<DocumentName>) - Constructor for class org.apache.rat.document.DocumentNameMatcher: Constructs a DocumentNameMatcher from a name and a DocumentName predicate.
DocumentNameMatcher(String, MatchPatterns) - Constructor for class org.apache.rat.document.DocumentNameMatcher: Constructs a DocumentNameMatcher from a name and a MatcherPatterns object.
DocumentNameMatcher(String, MatchPatterns, DocumentName) - Constructor for class org.apache.rat.document.DocumentNameMatcher: Constructs a DocumentNameMatcher from a name a MatchPatterns instance and the DocumentName for the base name.
DocumentNameMatcher(String, DocumentNameMatcher) - Constructor for class org.apache.rat.document.DocumentNameMatcher: Constructs a DocumentNameMatcher from a name and a delegate DocumentNameMatcher.
DocumentNameMatcher.DecomposeData - Class in org.apache.rat.document: Data from a DocumentNameMatcher.decompose(DocumentName) call.
DocumentNameMatcher.FileFilterPredicate - Class in org.apache.rat.document: A DocumentName predicate that uses FileFilter.
DocumentNameMatcher.MatchPatternsPredicate - Class in org.apache.rat.document: A DocumentName predicate that uses MatchPatterns.
DocumentNameMatcher.NotPredicate - Class in org.apache.rat.document: A DocumentName predicate that reverses another DocumentNameMatcher.
documentType(String, int) - Method in class org.apache.rat.report.xml.XmlElements: Creates a statistic element.
DOT - Enum constant in enum org.apache.rat.utils.CasedString.StringCase: Dot case tags phrases of words like 'phrase.case'.
doubleLine() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets two new lines.
DRY_RUN - Enum constant in enum org.apache.rat.commandline.Arg: Specifies that the run should not perform any updates to files.

E

ECLIPSE - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an Eclipse IDE based tool.
EDIT_ADD - Enum constant in enum org.apache.rat.commandline.Arg: Defines options to add licenses to files
EDIT_COPYRIGHT - Enum constant in enum org.apache.rat.commandline.Arg: Defines options to add copyright to files
EDIT_OVERWRITE - Enum constant in enum org.apache.rat.commandline.Arg: Causes file updates to overwrite existing files.
ELEMENT - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An element
emptyIterator() - Static method in class org.apache.rat.utils.ExtendedIterator: An empty Extended iterator
ENCODING - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The encoding for a text document
endReport() - Method in class org.apache.rat.report.AbstractReport: Deprecated.

Empty default implementation.
endReport() - Method in class org.apache.rat.report.claim.ClaimAggregator
endReport() - Method in class org.apache.rat.report.claim.ClaimReporterMultiplexer
endReport() - Method in class org.apache.rat.report.claim.ClaimValidatorReport
endReport() - Method in interface org.apache.rat.report.RatReport: Signals the end of execution for the report.
environmentVariables() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of environment variables.
EnvVar - Enum in org.apache.rat.api
equals(Object) - Method in class org.apache.rat.analysis.UnknownLicense
equals(Object) - Method in class org.apache.rat.api.Document
equals(Object) - Method in class org.apache.rat.document.DocumentName
equals(Object) - Method in class org.apache.rat.document.DocumentName.FSInfo
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
equals(ILicense, Object) - Static method in interface org.apache.rat.license.ILicense: A default implementation of equals.
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.
ERROR - Enum constant in enum org.apache.rat.utils.Log.Level: Log error only.
ExampleGenerator() - Constructor for class org.apache.rat.documentation.options.AntOption.ExampleGenerator: The constructor.
EXCLUDE - Enum constant in enum org.apache.rat.commandline.Arg: Excludes files by expression
EXCLUDE_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Excludes files based on the contents of a file.
EXCLUDE_PARSE_SCM - Enum constant in enum org.apache.rat.commandline.Arg: Excludes files based on SCM exclusion file processing.
EXCLUDE_SIZE - Enum constant in enum org.apache.rat.commandline.Arg: Excludes files if they are smaller than the given threshold.
EXCLUDE_STD - Enum constant in enum org.apache.rat.commandline.Arg: Excludes files based on standard groupings.
excluded - Variable in class org.apache.rat.config.exclusion.MatcherSet.Builder: The DocumentNameMatcher that specifies excluded files
excludes() - Method in interface org.apache.rat.config.exclusion.MatcherSet
ExclusionProcessor - Class in org.apache.rat.config.exclusion: Processes the include and exclude patterns and applies the result against a base directory to return an IReportable that contains all the reportable objects.
ExclusionProcessor() - Constructor for class org.apache.rat.config.exclusion.ExclusionProcessor: Constructs the processor.
ExclusionUtils - Class in org.apache.rat.config.exclusion: Utilities for exclusion processing.
execute() - Method in class org.apache.rat.anttasks.Help: Generates the help.
execute() - Method in class org.apache.rat.anttasks.Report: Generates the report.
execute() - Method in class org.apache.rat.mp.RatCheckMojo: Invoked by Maven to execute the Mojo.
execute() - Method in class org.apache.rat.mp.RatReportMojo: This method is called when the report generation is invoked directly as a standalone Mojo.
execute() - Method in class org.apache.rat.plugin.HelpMojo
execute() - Method in class org.apache.rat.Reporter: Executes the report and builds the output.
execute() - Method in class org.apache.rat.tools.AntDocumentation
executeReport(Locale) - Method in class org.apache.rat.mp.RatReportMojo: Writes the report to the Doxia sink.
Exporter - Class in org.apache.rat.documentation: Uses Apache Velocity to write a document containing RAT configuration information.
Exporter() - Constructor for class org.apache.rat.documentation.Exporter
Expr() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Expr
EXPRESSION - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A matching expression.
ExtendedIterator<T> - Class in org.apache.rat.utils: An ExtendedIterator is an Iterator wrapping around a plain (or presented as plain) Iterator.
EXTENSION - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: An extension
extractPattern(String, String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils

F

FAIL - Enum constant in enum org.apache.rat.utils.ReportingSet.Options
FALSE - Enum constant in enum org.apache.rat.config.AddLicenseHeaders: Do not add headers.
FAMILIES - Static variable in class org.apache.rat.configuration.XMLConfig: families element name
FAMILIES_APPROVED - Enum constant in enum org.apache.rat.commandline.Arg: Option that specifies approved license families
FAMILIES_APPROVED_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Option that specifies approved license families from a file
FAMILIES_DENIED - Enum constant in enum org.apache.rat.commandline.Arg: Option to list license families to remove from the approved list.
FAMILIES_DENIED_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Option to read a list of license families to remove from the approved list.
family() - Method in class org.apache.rat.documentation.velocity.License: Gets the family name of this license.
Family - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Family - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Family() - Constructor for class org.apache.rat.anttasks.Family: Deprecated.
Family() - Constructor for class org.apache.rat.mp.Family: Deprecated.
FAMILY - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The family category
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.
FAMILYID - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A license family id.
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.
FILE - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A plain file.
FILE_CONVERTER - Static variable in class org.apache.rat.commandline.Converters: Creates a File with fully qualified name.
FileDocument - Class in org.apache.rat.document: Document wrapping a File object.
FileDocument(File, DocumentNameMatcher) - Constructor for class org.apache.rat.document.FileDocument: Creates a File document where the baseDir is the root directory.
FileDocument(DocumentName, File, DocumentNameMatcher) - Constructor for class org.apache.rat.document.FileDocument: Creates a File document.
FileListWalker - Class in org.apache.rat.walker: Implementation of IReportable that traverses over a resource collection internally.
FileListWalker(FileDocument) - Constructor for class org.apache.rat.walker.FileListWalker: Constructor.
fileName - Variable in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: The name of the file being processed
Filename() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Filename
fileProcessorBuilder() - Method in enum org.apache.rat.config.exclusion.StandardCollection: Returns the fileProcessor if it exists.
filter(Predicate<T>) - Method in class org.apache.rat.utils.ExtendedIterator: Filter this iterator using a predicate.
filterChildren(Predicate<Description>) - Method in class org.apache.rat.config.parameters.Description: Gets 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(String) - Static method in enum org.apache.rat.commandline.Arg: Finds the Arg that contains an Option with the specified key.
findArg(Option) - Static method in enum org.apache.rat.commandline.Arg: Finds the Arg that an Option is in.
finish() - Method in class org.apache.rat.tools.xsd.XsdWriter: Finishes the process.
first() - Method in class org.apache.rat.utils.ReportingSet
flatten(Iterator<Iterator<T>>) - Static method in class org.apache.rat.utils.ExtendedIterator: Given an Iterator that returns Iterators, this creates an Iterator over the next level values.
flush() - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
FORCED - Enum constant in enum org.apache.rat.config.AddLicenseHeaders: Add headers and overwrite the existing file.
forEach(Consumer<? super T>) - Method in class org.apache.rat.utils.ReportingSet
forEachRemaining(Consumer<? super T>) - Method in class org.apache.rat.utils.ExtendedIterator
Format - Enum in org.apache.rat.configuration: An enumeration of the types of files that can contain the configuration information.
formatLogEntry(String, Throwable) - Static method in interface org.apache.rat.utils.Log
forRemoval() - Element in annotation type org.apache.rat.DeprecationReporter.Info: The description of the component.
from(File) - Static method in enum org.apache.rat.configuration.Format: Determine the Format from a file.
from(Exception) - Static method in exception org.apache.rat.ConfigurationException
from(String) - Static method in enum org.apache.rat.configuration.Format: Determine the Format from the file name.
from(String, Iterable<String>) - Static method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
from(String, String...) - Static method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
from(URI) - Static method in enum org.apache.rat.configuration.Format: Determine the Format from a URI.
fromMediaType(MediaType) - Static method in class org.apache.rat.analysis.TikaProcessor: Gets the Document.Type based on the MediaType.
fromProjectLevel(int) - Static method in class org.apache.rat.anttasks.Report: Converts to RAT log level from Ant Project log level.
FSInfo(String, FileSystem) - Constructor for class org.apache.rat.document.DocumentName.FSInfo: Constructor.
FSInfo(FileSystem) - Constructor for class org.apache.rat.document.DocumentName.FSInfo: Constructor.
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

generate(Sink, Locale) - Method in class org.apache.rat.mp.RatReportMojo: Deprecated.
use RatReportMojo.generate(Sink, SinkFactory, Locale) instead.
generate(Sink, SinkFactory, Locale) - Method in class org.apache.rat.mp.RatReportMojo: This method is called when the report generation is invoked by maven-site-plugin.
generate(Sink, Locale) - Method in class org.apache.rat.mp.RatReportMojo: Deprecated.
use RatReportMojo.generate(Sink, SinkFactory, Locale) instead.
get(String) - Method in interface org.apache.rat.BuilderParams: Gets one of the contained methods by name.
getActualAntOption() - Method in class org.apache.rat.documentation.options.AntOption: If this option is converted to another option return that option otherwise return this option.
getAntOptions() - Static method in class org.apache.rat.documentation.options.AntOption: Gets the list of all available Ant options.
getApprovedLicensePredicate() - Method in class org.apache.rat.license.LicenseSetFactory: Gets a predicate to filter for approved licenses.
getArchiveProcessing() - Method in class org.apache.rat.ReportConfiguration: Retrieves the archive processing type.
getArg(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Get the list of values for a key.
getArg(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Get the list of values for a key.
getArgName() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the argument name if there is one.
getArgType() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the argument type if there is one.
getArgumentTypes() - Static method in class org.apache.rat.OptionCollection: Deprecated.
use OptionCollection.ArgumentType
getAttributeFunctionName() - Method in class org.apache.rat.documentation.options.AntOption: Get the signature of the attribute function.
getAttributes() - Method in class org.apache.rat.documentation.velocity.Matcher: Gets the attributes of this matcher.
getAttributes() - Method in class org.apache.rat.documentation.velocity.MatcherTree.Node: Gets the attributes only if they have values.
getBaseDocumentName() - Method in class org.apache.rat.document.DocumentName: Gets the DocumentName for the basename of this DocumentName.
getBaseName() - Method in class org.apache.rat.document.ArchiveEntryName
getBaseName() - Method in class org.apache.rat.document.DocumentName: Gets the fully qualified basename of the document.
getBuiltClass(Class<? extends IHeaderMatcher.Builder>) - Static method in class org.apache.rat.config.parameters.DescriptionBuilder
getCategory() - Method in class org.apache.rat.license.ILicenseFamily.Builder: Gets the category that this builder is building.
getCategoryName() - Method in class org.apache.rat.mp.RatReportMojo
getCharset() - Method in class org.apache.rat.api.MetaData: Gets the charset for the document.
getChildElements(String, List<String>) - Method in class org.apache.rat.documentation.options.AntOption.ExampleGenerator: Creates a string comprising the child elements for the Ant XML report call.
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.
getClaimValidator() - Method in class org.apache.rat.ReportConfiguration: Gets the ClaimValidator for the configuration.
getClasses() - Method in class org.apache.rat.configuration.MatcherBuilderTracker: Gets a collection of classes that are recognized as builders.
getClassName() - Method in class org.apache.rat.mp.HeaderMatcherSpecification: Deprecated.

Returns the license matchers class name.
getCollection() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Gets the phrase "or more " if the enclosed matcher may be multiple.
getCommandLine() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the command line.
getComment(boolean) - Method in class org.apache.rat.documentation.options.AntOption: Get the method comment for this option.
getCommonName() - Method in class org.apache.rat.config.parameters.Description: Gets the common name for the matcher.
getConfiguration() - Method in class org.apache.rat.anttasks.Report: Creates the ReportConfiguration from the Ant options.
getConfiguration() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the configuration.
getConfiguration() - Method in class org.apache.rat.mp.AbstractRatMojo
getConfiguration() - Method in class org.apache.rat.mp.RatCheckMojo
getCopyrightMessage() - Method in class org.apache.rat.ReportConfiguration: Returns the optional license copyright being added if RAT is adding headers.
getCounter(Document.Type) - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the counts for the Document.Type.
getCounter(ClaimStatistic.Counter) - Method in class org.apache.rat.report.claim.ClaimStatistic: Returns the counts for the counter.
getDefault() - Static method in class org.apache.rat.DeprecationReporter: Get the default reporter.
getDefault() - Static method in class org.apache.rat.document.DocumentName.FSInfo
getDefaultMaxValue() - Method in enum org.apache.rat.report.claim.ClaimStatistic.Counter: Gets the default maximum value for the counter.
getDefaultMinValue() - Method in enum org.apache.rat.report.claim.ClaimStatistic.Counter: Gets the default minimum value for the counter.
getDefaultsBuilder() - Method in class org.apache.rat.mp.AbstractRatMojo
getDefaultValue() - Method in class org.apache.rat.documentation.options.AbstractOption: Return default value.
getDefaultValue() - Method in class org.apache.rat.documentation.options.MavenOption
getDeprecated() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the deprecated string if the option is deprecated, or an empty string otherwise.
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 interface org.apache.rat.config.exclusion.MatcherSet
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.documentation.options.AbstractOption: Gets the description in implementation specific format.
getDescription() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the description of the attribute or an empty string.
getDescription() - Method in class org.apache.rat.documentation.velocity.Matcher: Gets the description of the matcher type.
getDescription() - Method in enum org.apache.rat.report.claim.ClaimStatistic.Counter: Gets the description of the counter.
getDescription(Locale) - Method in class org.apache.rat.mp.RatReportMojo: Returns the reports description.
getDirectorySeparator() - Method in class org.apache.rat.document.DocumentName: Returns the directory separator.
getDisplayName() - Method in enum org.apache.rat.OptionCollection.ArgumentType
getDocument() - Method in class org.apache.rat.Reporter: Gets the document that was generated during execution.
getDocument() - Method in class org.apache.rat.walker.Walker: Retrieves the document from the constructor.
getDocumentExcluder(DocumentName) - Method in class org.apache.rat.ReportConfiguration: Get the DocumentNameMatcher that excludes files found in the directory tree..
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.
getDocumentTypes() - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the list of Document.Types seen in the run.
getElementName() - Method in enum org.apache.rat.report.xml.XmlElements.Elements: Gets the XML element name.
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
getEnclosed() - Method in class org.apache.rat.documentation.velocity.Matcher: If the matcher encloses another matcher return the definition of that enclosure.
getEnclosed() - Method in class org.apache.rat.documentation.velocity.MatcherTree.Node: Gets the enclosed node only if it is another matcher.
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.
getExample() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets an example of how to use this option in the native UI.
getExample() - Method in class org.apache.rat.documentation.options.AntOption
getExample() - Method in class org.apache.rat.documentation.options.CLIOption
getExample() - Method in class org.apache.rat.documentation.options.MavenOption
getExample(String, Map<String, String>, List<String>) - Method in class org.apache.rat.documentation.options.AntOption.ExampleGenerator: Gets an example Ant XML report call using ant option with the specified attributes and child elements.
getExampleAttributes(String, Map<String, String>) - Method in class org.apache.rat.documentation.options.AntOption.ExampleGenerator: Creates a string comprising the attributes for the Ant XML report call.
getExpression() - Method in class org.apache.rat.analysis.matchers.SimpleRegexMatcher: Gets the expression of the underlying matching pattern.
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.
getFile() - Method in class org.apache.rat.document.FileDocument: Gets the file underlying this document.
getFilteredOptions() - Static method in class org.apache.rat.documentation.options.AntOption: Gets the set of options that are not supported by Ant either by not being supported or by being converted to another argument.
getFilteredOptions() - Static method in class org.apache.rat.documentation.options.MavenOption: Gets the set of options that are not supported by Maven.
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.
getGeneratedMatcher() - Method in class org.apache.rat.ReportConfiguration: Gets the matcher that matches generated text.
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
getInputEncoding() - Method in class org.apache.rat.mp.RatReportMojo: Gets the input files encoding.
getInputStream() - Method in class org.apache.rat.tools.xsd.XsdGenerator: Create an input stream from the output of the generator.
getInstance() - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils
getInstance() - Static method in class org.apache.rat.utils.DefaultLog: Retrieves the 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.
getLevel() - Method in interface org.apache.rat.utils.Log: Gets the log level that is enabled.
getLevelBuilder(int) - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder
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 the 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. approved - Only approved license families will be returned none - No license families will be returned
getLicenseFamily() - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
getLicenseFamily() - Method in interface org.apache.rat.analysis.license.DeprecatedConfig: Deprecated.
getLicenseFamily() - Method in class org.apache.rat.analysis.UnknownLicense
getLicenseFamily() - Method in interface org.apache.rat.license.ILicense: 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.
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.
getLicenseNameCount(String) - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the counts for the license name.
getLicenseNames() - Method in class org.apache.rat.report.claim.ClaimStatistic: Gets the license names sorted by name.
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: Gets the enclosed LicenseSetFactory.
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 class org.apache.rat.documentation.velocity.License: Gets the matcher associated with this license.
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.
getMatcherTree() - Method in class org.apache.rat.documentation.velocity.License: Gets the matcher tree associated with this license.
getMavenOptions() - Static method in class org.apache.rat.documentation.options.MavenOption
getMax(ClaimStatistic.Counter) - Method in class org.apache.rat.config.results.ClaimValidator: Gets the limit for the specific counter.
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.
getMethodFormat(AntOption) - Method in class org.apache.rat.tools.AntGenerator.GenerateType
getMethodSignature(String, boolean) - Method in class org.apache.rat.documentation.options.MavenOption
getMin(ClaimStatistic.Counter) - Method in class org.apache.rat.config.results.ClaimValidator: Gets the limit for the specific counter.
getName() - Method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match: Gets the name of this matcher.
getName() - Method in class org.apache.rat.analysis.UnknownLicense
getName() - Method in class org.apache.rat.api.Document: Gets the name of the current document.
getName() - Method in class org.apache.rat.document.DocumentName: Gets the fully qualified name of the document.
getName() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the implementation specific name for the CLI option.
getName() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the attribute name.
getName() - Method in class org.apache.rat.documentation.velocity.Matcher: Get the name of the matcher type.
getName() - Method in interface org.apache.rat.license.ILicense: Returns the name of this license.
getName() - Method in class org.apache.rat.license.SimpleLicense
getName() - Method in interface org.apache.rat.report.IReportable: Returns the DocumentName for the reportable.
getName() - Method in class org.apache.rat.walker.FileListWalker
getName() - Method in class org.apache.rat.walker.IReportableListWalker
getName() - Method in class org.apache.rat.walker.Walker
getName(Locale) - Method in class org.apache.rat.mp.RatReportMojo: Returns the reports name.
getNameMatcher() - Method in class org.apache.rat.api.Document: Gets the file filter this document was created with.
getNameMatcher(DocumentName) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Creates a Document name matcher that will return false on any document that is excluded.
getNative() - Method in class org.apache.rat.anttasks.Report.AddLicenseHeaders: Deprecated.
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.
getOption() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the option this abstract option is wrapping.
getOptionComparator() - Method in class org.apache.rat.anttasks.Help.AntHelpFormatter
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.
getOutputDirectory() - Method in class org.apache.rat.mp.RatReportMojo
getOutputEncoding() - Method in class org.apache.rat.mp.RatReportMojo: Gets the effective reporting output files encoding.
getOutputName() - Method in class org.apache.rat.mp.RatReportMojo: Returns the reports file name.
getOwner() - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher: Gets the owner of the copyright.
getParamValue(Object) - Method in class org.apache.rat.config.parameters.Description: Retrieve the value of the described parameter from the specified object.
getPattern(AntOption, AntOption) - Method in class org.apache.rat.tools.AntGenerator.GenerateType
getPatterns() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense: Deprecated.
getPredicate() - Method in class org.apache.rat.document.DocumentNameMatcher: Returns the predicate that this DocumentNameMatcher is using.
getProject() - Method in class org.apache.rat.mp.AbstractRatMojo
getPropertyAnnotation(String) - Method in class org.apache.rat.documentation.options.MavenOption
getRatTxtFile() - Method in class org.apache.rat.mp.RatCheckMojo: Reads the location of the RAT text file from the Mojo.
getRefId() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy: Gets the matcher ID that this proxy references.
getRenameMap() - Static method in class org.apache.rat.documentation.options.AntOption
getRenameMap() - Static method in class org.apache.rat.documentation.options.MavenOption
getReportOutputDirectory() - Method in class org.apache.rat.mp.RatReportMojo
getRequired() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the required flag.
getRequired() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Gets the required flag.
getResource() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer: Get the resource that was provided in the constructor.
getRoot() - Method in class org.apache.rat.document.DocumentName: Gets the root for this document.
getRoot() - Method in class org.apache.rat.documentation.velocity.MatcherTree: Gets the description of the root of the tree.
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.
getShortName() - Method in class org.apache.rat.document.DocumentName: Gets the last segment of the name.
getSimpleText() - Method in class org.apache.rat.analysis.matchers.SimpleTextMatcher
getSink() - Method in class org.apache.rat.mp.RatReportMojo
getSinkFactory() - Method in class org.apache.rat.mp.RatReportMojo
getSiteRenderer() - Method in class org.apache.rat.mp.RatReportMojo
getSources() - Method in class org.apache.rat.ReportConfiguration: Gets a builder initialized with any files specified as sources.
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.
getStandardExclusion() - Method in class org.apache.rat.Defaults: Gets the default exclusion processor.
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() - Method in class org.apache.rat.ReportConfiguration: Gets the IOSupplier with the style sheet.
getStyleSheet(String) - Static method in enum org.apache.rat.commandline.StyleSheets: Gets the IOSupplier for a style sheet.
getter(Class<?>) - Method in class org.apache.rat.config.parameters.Description: Returns the getter for the component in the specified class.
getText() - Method in class org.apache.rat.documentation.options.AbstractOption: return a string showing long and short options if they are available.
getText() - Method in class org.apache.rat.documentation.options.AntOption
getText() - Method in class org.apache.rat.documentation.options.CLIOption
getText() - Method in class org.apache.rat.documentation.options.MavenOption
getTitle() - Method in class org.apache.rat.VersionInfo: Gets the implementation title of the package.
getTokenizedPathChars() - Method in class org.apache.rat.config.exclusion.plexus.MatchPattern
getTokenizedPathString() - Method in class org.apache.rat.config.exclusion.plexus.MatchPattern
getType() - Method in class org.apache.rat.config.parameters.Description: Gets the type of the component.
getType() - Method in class org.apache.rat.documentation.options.AbstractOption: Gets the simple class name for the data type for this option.
getType() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Get the type of the attribute.
getType() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Get the type of the enclosed matcher.
getType(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Detect the type of document.
getUnsupportedOptions() - Static method in class org.apache.rat.documentation.options.AntOption: Gets the list of unsupported options.
getValue() - Method in enum org.apache.rat.api.EnvVar: Gets the value for the EnvVar.
getValue() - Method in class org.apache.rat.documentation.velocity.Matcher.Attribute: Gets the value of the enclosed matcher.
getValue() - Method in class org.apache.rat.documentation.velocity.Matcher.Enclosed: Gets the value of the enclosed matcher.
getValues() - Method in class org.apache.rat.anttasks.Report.AddLicenseHeaders: Deprecated.
getValues() - Method in class org.apache.rat.anttasks.Report.ApprovalFilter: Deprecated.
getValues(Arg) - Method in class org.apache.rat.anttasks.Report: Reads values for the Arg.
getValues(Arg) - Method in class org.apache.rat.mp.AbstractRatMojo: Reads values for the Arg.
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.
getWorkingDirectory() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the directory name from which relative file names will be resolved.
getWriter() - Method in class org.apache.rat.ReportConfiguration: Gets a PrintWriter that wraps the output stream.
GIT - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by GIT source code control to support GIT, also processes files listed in '.gitignore' and (unless RAT_NO_GIT_GLOBAL_IGNORE is specified) the global gitignore.
GitIgnoreBuilder - Class in org.apache.rat.config.exclusion.fileProcessors: Processes the .gitignore file.
GitIgnoreBuilder() - Constructor for class org.apache.rat.config.exclusion.fileProcessors.GitIgnoreBuilder: Constructs a file processor that processes a .gitignore file and ignores any lines starting with "#".
globalGitIgnore() - Method in class org.apache.rat.config.exclusion.fileProcessors.GitIgnoreBuilder: The global gitignore file to process, based on the EnvVar.RAT_NO_GIT_GLOBAL_IGNORE, EnvVar.XDG_CONFIG_HOME and EnvVar.HOME environment variables.
group() - Method in enum org.apache.rat.commandline.Arg: Gets the group for this arg.

H

handleApprovedLicenseClaim(MetaData) - Method in class org.apache.rat.report.claim.AbstractClaimReporter: Increment the approved license claim.
handleApprovedLicenseClaim(MetaData) - Method in class org.apache.rat.report.claim.ClaimAggregator
handleDocumentCategoryClaim(Document.Type) - Method in class org.apache.rat.report.claim.AbstractClaimReporter: Increment the document type counter.
handleDocumentCategoryClaim(Document.Type) - Method in class org.apache.rat.report.claim.ClaimAggregator
handleLicenseClaim(ILicense) - Method in class org.apache.rat.report.claim.AbstractClaimReporter: Increment the counts associated with the license The default implementation does nothing.
handleLicenseClaim(ILicense) - Method in class org.apache.rat.report.claim.ClaimAggregator
hasArg() - Method in class org.apache.rat.documentation.options.AbstractOption: Determine if the enclosed option expects an argument.
hasArgs() - Method in class org.apache.rat.documentation.options.AbstractOption: Returns true if the option has multiple arguments.
hasCharset() - Method in class org.apache.rat.api.MetaData: Returns true if MetaData.setCharset(java.nio.charset.Charset) has been called.
hasErrors() - Method in class org.apache.rat.config.results.ClaimValidator: Returns true if any validation failed.
hash(ILicense) - Static method in interface org.apache.rat.license.ILicense: A default implementation 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.document.DocumentName.FSInfo
hashCode() - Method in class org.apache.rat.document.DocumentName
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.
hasNext() - Method in class org.apache.rat.utils.ExtendedIterator
hasSource() - Method in class org.apache.rat.ReportConfiguration: Returns true if the configuration has any sources defined.
hasStaticDocumentNameMatcher() - Method in enum org.apache.rat.config.exclusion.StandardCollection: Returns true if the collections has a document name match supplier.
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(IHeaderMatcher, Reader, int, Collection<ILicense>, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker: Constructs a check worker for the license against the specified document.
HeaderCheckWorker(IHeaderMatcher, Reader, Collection<ILicense>, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker: Convenience constructor wraps given Reader in a BufferedReader.
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.
HeaderMatcherSpecification - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
HeaderMatcherSpecification() - Constructor for class org.apache.rat.mp.HeaderMatcherSpecification: Deprecated.
headSet(T) - Method in class org.apache.rat.utils.ReportingSet
Help - Class in org.apache.rat.anttasks: A basic Ant task that generates a report on all files specified by the nested resource collection(s).
Help - Class in org.apache.rat.help: The help output for the command line client.
Help() - Constructor for class org.apache.rat.anttasks.Help: Constructor.
Help(PrintStream) - Constructor for class org.apache.rat.help.Help: Creates a Help instance to print to the specified stream.
Help(Writer) - Constructor for class org.apache.rat.help.Help: Creates a Help instance to write to the specified writer.
HELP - Static variable in class org.apache.rat.OptionCollection: The Help option
HELP_LICENSES - Enum constant in enum org.apache.rat.commandline.Arg: Provide license definition listing of registered licenses.
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.
Help.AntHelpFormatter - Class in org.apache.rat.anttasks
helpFormatter - Variable in class org.apache.rat.help.AbstractHelp: The help formatter for this instance
HelpMojo - Class in org.apache.rat.plugin: Display help information on apache-rat-plugin.
Call mvn apache-rat:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.apache.rat.plugin.HelpMojo
HgIgnoreBuilder - Class in org.apache.rat.config.exclusion.fileProcessors: A processor for the .hgignore files.
HgIgnoreBuilder() - Constructor for class org.apache.rat.config.exclusion.fileProcessors.HgIgnoreBuilder: Constructs the .hgignore processor.
HIDDEN_DIR - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The hidden directories.
HIDDEN_FILE - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The hidden files.
HOME - Enum constant in enum org.apache.rat.api.EnvVar: Defines the user HOME.

I

id() - Method in class org.apache.rat.documentation.velocity.License: Gets the id for this license if it is not a system generated one.
ID - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The id
IDEA - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an IDEA IDE based tool.
IGNORE - Enum constant in enum org.apache.rat.utils.ReportingSet.Options
IGNORED - Enum constant in enum org.apache.rat.api.Document.Type: A generated document that is ignored.
IGNORED - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of generated/ignored files
IgnoredDocument - Class in org.apache.rat.document: Document wrapping a File object that is ignored by rule.
IgnoredDocument(DocumentName, File, DocumentNameMatcher) - Constructor for class org.apache.rat.document.IgnoredDocument: Creates a File 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: Constructor.
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 - Class in org.apache.rat.license: The definition of an ILicenseFamily builder.
ILicenseFamilyBuilder - Class in org.apache.rat.license: Deprecated.
use ILicenseFamily.Builder
ILicenseFamilyBuilder() - Constructor for class org.apache.rat.license.ILicenseFamilyBuilder: Deprecated.
ImplementationException - Exception in org.apache.rat: An exception thrown when there is an issue with the implementation of an extension point.
ImplementationException(String) - Constructor for exception org.apache.rat.ImplementationException
ImplementationException(String, Throwable) - Constructor for exception org.apache.rat.ImplementationException
ImplementationException(Throwable) - Constructor for exception org.apache.rat.ImplementationException
incCounter(Document.Type, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the number of times the Document.Type was seen.
incCounter(ClaimStatistic.Counter, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the counts for the counter.
incLicenseCategoryCount(String, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the number of times a license family category was seen.
incLicenseNameCount(String, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the license family name count.
INCLUDE - Enum constant in enum org.apache.rat.commandline.Arg: Excludes files by expression.
INCLUDE_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Includes files based on the contents of a file.
INCLUDE_STD - Enum constant in enum org.apache.rat.commandline.Arg: Includes files based on standard groups.
included - Variable in class org.apache.rat.config.exclusion.MatcherSet.Builder: The DocumentNameMatcher that specifies included files
includes() - Method in interface org.apache.rat.config.exclusion.MatcherSet
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.
INFO - Enum constant in enum org.apache.rat.utils.Log.Level: Log info only.
init() - Static method in class org.apache.rat.Defaults: Initialize the system configuration reader.
init() - Method in class org.apache.rat.tools.xsd.XsdWriter: Initializes the writer.
innerClass - Variable in class org.apache.rat.tools.AntGenerator.GenerateType: the inner class name text
inputStream() - Method in class org.apache.rat.api.Document: Streams the document's contents.
inputStream() - Method in class org.apache.rat.document.ArchiveEntryDocument
inputStream() - Method in class org.apache.rat.document.FileDocument
inputStream() - Method in class org.apache.rat.document.IgnoredDocument
instance() - Static method in class org.apache.rat.configuration.MatcherBuilderTracker: Gets the instance of the MatcherBuilderTracker.
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.
INTEGER - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: An Integer.
internalFilter() - Method in class org.apache.rat.anttasks.Report.ApprovalFilter: Deprecated.
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
IReportableListWalker - Class in org.apache.rat.walker: A Reportable that walks a list of IReportables and executes the run on each.
IReportableListWalker.Builder - Class in org.apache.rat.walker: A Builder for the ListWalker.
IS_DIRECTORY - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: Denotes a skipped directory
isAddingLicenses() - Method in class org.apache.rat.ReportConfiguration: Gets the flag that determines if license headers should be added if missing.
isAddingLicensesForced() - Method in class org.apache.rat.ReportConfiguration: Gets the flag that determines if license headers are "forced" overwriting existing files.
isAntPrefixedPattern(String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils
isApproved(ILicense) - Method in class org.apache.rat.api.MetaData: Determine if the license is an approved license.
isAttribute() - Method in class org.apache.rat.documentation.options.AntOption: Returns true if the option should be an attribute of the <rat:report> element.
isCaseSensitive() - Method in class org.apache.rat.document.DocumentName.FSInfo: Gets the case-sensitivity flag.
isCaseSensitive() - Method in class org.apache.rat.document.DocumentName: Gets the case sensitivity flag.
isCollection() - Method in class org.apache.rat.config.parameters.Description: Get the isCollection flag.
isCollection() - Method in class org.apache.rat.document.DocumentNameMatcher
isDeprecated() - Method in class org.apache.rat.documentation.options.AbstractOption: Determines if the option is deprecated.
isDirectory() - Method in class org.apache.rat.api.Document: Determines if this document is a directory type.
isDirectory() - Method in class org.apache.rat.api.MetaData: Return true if the directory flag was set.
isDirectory() - Method in class org.apache.rat.document.ArchiveEntryDocument
isDirectory() - Method in class org.apache.rat.document.FileDocument
isDirectory() - Method in class org.apache.rat.document.IgnoredDocument
isDryRun() - Method in class org.apache.rat.ReportConfiguration: Returns the state of the dry run flag.
isElement() - Method in class org.apache.rat.documentation.options.AntOption: Returns true if the option should be a child element of the <rat:report> element.
isEmpty() - Method in class org.apache.rat.utils.ReportingSet
isEnabled(Log.Level) - Method in interface org.apache.rat.utils.Log: Determines if the log level is enabled.
isExternalReport() - Method in class org.apache.rat.mp.RatReportMojo
isHidden(String) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Returns true if the filename represents a hidden file
isIgnored() - Method in class org.apache.rat.api.Document: Checks if document is ignored or not.
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 an 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(Document) - Static method in class org.apache.rat.document.guesser.NoteGuesser: Determines if the document is a note.
isOutOfDate(File, File, int) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Returns dependency information on these two files.
isRegexPrefixedPattern(String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils
isRequired() - Method in class org.apache.rat.config.parameters.Description: Get the canBeChild flag.
isRequired() - Method in class org.apache.rat.documentation.options.AbstractOption: Determines if the option is required.
isSelected() - Method in enum org.apache.rat.commandline.Arg: Determines if the group has a selected element.
isSet() - Method in enum org.apache.rat.api.EnvVar: Determines if this EnvVar is set.
isValid(ClaimStatistic.Counter, int) - Method in class org.apache.rat.config.results.ClaimValidator: Determines if the specified count is within the limits for the counter.
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.

K

KEBAB - Enum constant in enum org.apache.rat.utils.CasedString.StringCase: Kebab case tags strings like 'kebab-case'.
keyValue() - Method in class org.apache.rat.documentation.options.AbstractOption: The key value for the option.

L

last() - Method in class org.apache.rat.utils.ReportingSet
level() - Method in class org.apache.rat.documentation.velocity.MatcherTree.Node: Gets the level in the tree of this node.
LevelBuilder() - Constructor for class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder.LevelBuilder
license(ILicense, boolean) - Method in class org.apache.rat.report.xml.XmlElements: Creates a license element.
License - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
License - Class in org.apache.rat.documentation.velocity: The License representation for documentation.
License - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
License() - Constructor for class org.apache.rat.anttasks.License: Deprecated.
License() - Constructor for class org.apache.rat.mp.License: Deprecated.
LICENSE - Enum constant in enum org.apache.rat.config.parameters.ComponentType: A License, the top level component.
LICENSE - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A license element
LICENSE - Static variable in class org.apache.rat.configuration.XMLConfig: license element name
LICENSE_CATEGORIES - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of license categories
LICENSE_CATEGORY - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A license category entry
LICENSE_NAME - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A license name entry
LICENSE_NAMES - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of distinct license names
LicenseAddingReport - Class in org.apache.rat.report.claim: A Report that adds licenses text to files.
LicenseAddingReport(String, boolean) - Constructor for class org.apache.rat.report.claim.LicenseAddingReport: Creates a LicenseAddingReport that inserts the copyright message and may overwrite the files.
licenseCategory(String, int) - Method in class org.apache.rat.report.xml.XmlElements: Creates a statistic element.
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.
LICENSEFILTER - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A license filter.
LICENSEID - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A license id.
licenseName(String, int) - Method in class org.apache.rat.report.xml.XmlElements: Creates a statistic element.
licenseProperties() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a list of license property descriptions.
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() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of defined licenses.
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
LICENSES - Static variable in class org.apache.rat.configuration.XMLConfig: licenses element name
LICENSES_APPROVED - Enum constant in enum org.apache.rat.commandline.Arg: Option that adds approved licenses to the list
LICENSES_APPROVED_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Option that adds approved licenses from a file
LICENSES_DENIED - Enum constant in enum org.apache.rat.commandline.Arg: Option to remove licenses from the approved list
LICENSES_DENIED_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Option to read a file licenses to be removed from the approved list.
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.ArchiveEntryDocument
listChildren() - Method in class org.apache.rat.document.FileDocument
listChildren() - Method in class org.apache.rat.document.IgnoredDocument
listFamilies() - Method in class org.apache.rat.ReportConfiguration: Return the current filter that determines which families will be output in the XML document.
listFamilies(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Set the level of license families that should be output in the XML document.
listFiles(File, FileFilter) - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Create a list of files by applying the filter to the specified directory.
listIssues(ClaimStatistic) - Method in class org.apache.rat.config.results.ClaimValidator: Creates a list of items that have issues.
listLicenses() - Method in class org.apache.rat.ReportConfiguration: Gets the selected license filter.
listLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Set the level of licenses that should be output in the XML document.
listLicenses(ReportConfiguration, LicenseSetFactory.LicenseFilter) - Static method in class org.apache.rat.Reporter: Lists the licenses on the configured output stream.
localized() - Method in class org.apache.rat.document.DocumentName: Gets the portion of the name that is not part of the base name.
localized(String) - Method in class org.apache.rat.document.ArchiveEntryName
localized(String) - Method in class org.apache.rat.document.DocumentName: Gets the portion of the name that is not part of the base name.
log(String, int) - Method in class org.apache.rat.anttasks.Help
log(String, int) - Method in class org.apache.rat.anttasks.Report
log(String, Throwable, int) - Method in class org.apache.rat.anttasks.Help
log(String, Throwable, int) - Method in class org.apache.rat.anttasks.Report
log(Log.Level, Object) - Method in interface org.apache.rat.utils.Log: Writes a log message at the specified 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(Log.Level, String) - Method in class org.apache.rat.utils.DefaultLog
log(Log.Level, String) - Method in interface org.apache.rat.utils.Log: Writes a message at a specific log level.
log(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 - Interface in org.apache.rat.utils: The definition of logging for the core.
LOG_LEVEL - Enum constant in enum org.apache.rat.commandline.Arg: Specifies the log level to log messages at.
Log.Level - Enum in org.apache.rat.utils: The log levels supported by logging.
logDecompositionWhileMatching(DocumentName) - Method in class org.apache.rat.document.DocumentNameMatcher: Calculates the match result and logs the calculations.
logDeprecated(Class<?>) - Static method in class org.apache.rat.DeprecationReporter: Log Deprecated class use.
logDeprecated(String, String, boolean, String) - 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.
logIssues(ClaimStatistic) - Method in class org.apache.rat.config.results.ClaimValidator: Logs all the invalid values as errors.
LOGLEVEL - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A log level.
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.
logLicenses(Collection<ILicense>) - Method in class org.apache.rat.mp.AbstractRatMojo
logParseException(ParseException, Option, Object) - Method in class org.apache.rat.commandline.ArgumentContext: Logs a ParseException as a warning.
Lst() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Lst

M

MAC - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The .DS_Store files on Mac computers.
main(String[]) - Static method in class org.apache.rat.documentation.Exporter: Executes the generation of documentation from a configuration definition.
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.tools.AntDocumentation: Creates apt documentation files for Ant.
main(String[]) - Static method in class org.apache.rat.tools.AntGenerator: Creates a base class for an Ant task.
main(String[]) - Static method in class org.apache.rat.tools.ArgumentTypes
main(String[]) - Static method in class org.apache.rat.tools.Documentation: Creates the documentation.
main(String[]) - Static method in class org.apache.rat.tools.MavenGenerator: Creates the Maven MojoClass Requires 3 arguments: the package name for the class the simple class name the directory in which to write the class file.
main(String[]) - Static method in class org.apache.rat.tools.Naming: Creates the CSV file.
main(String[]) - Static method in class org.apache.rat.tools.xsd.XsdGenerator: Command line that accepts standard RAT CLI command line options and generates an XSD from the configuration.
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.ImplementationException
makeRatException(Exception) - Static method in exception org.apache.rat.api.RatException: Creates a RatException out of any other type of exception.
map(Function<T, U>) - Method in class org.apache.rat.utils.ExtendedIterator: Map the elements of the iterator to a now type.
markdownEscape(String) - Method in class org.apache.rat.documentation.velocity.RatTool: Escapes a string for markdown.
markSupportedInputStream(InputStream) - Static method in class org.apache.rat.analysis.TikaProcessor: Ensures that the input stream supports mark.
match(char[], char[], boolean) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils
match(String, String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Tests whether or not a string matches against a pattern.
match(String, String, boolean) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Tests whether or not a string matches against a pattern.
MATCH_FILTER - Static variable in class org.apache.rat.config.exclusion.ExclusionUtils: A predicate that filters out lines that start with ExclusionUtils.NEGATION_PREFIX.
Matcher - Class in org.apache.rat.documentation.velocity: The Matcher representation for documentation.
MATCHER - Enum constant in enum org.apache.rat.config.parameters.ComponentType: A Matcher
MATCHER - Static variable in class org.apache.rat.configuration.XMLConfig: matcher element name
Matcher.Attribute - Class in org.apache.rat.documentation.velocity: The definition of an attribute.
Matcher.Enclosed - Class in org.apache.rat.documentation.velocity: The description of an enclosed matcher.
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() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the set of Matchers.
MATCHERS - Static variable in class org.apache.rat.configuration.XMLConfig: matchers element name
matcherSet(DocumentNameMatcher, DocumentNameMatcher) - Static method in class org.apache.rat.document.DocumentNameMatcher: A particular matcher that will not match any excluded unless they are listed in the includes.
MatcherSet - Interface in org.apache.rat.config.exclusion: The file processor reads the file specified in the DocumentName.
MatcherSet.Builder - Class in org.apache.rat.config.exclusion: A MatcherSet that assumes the files contain the already formatted strings and just need to be localised for the fileName.
MatcherTree - Class in org.apache.rat.documentation.velocity: The representation of the Matcher tree found in a License.
MatcherTree(IHeaderMatcher) - Constructor for class org.apache.rat.documentation.velocity.MatcherTree: Constructor.
MatcherTree.Node - Class in org.apache.rat.documentation.velocity: The representation of a node in a License Matcher tree.
matches(String, boolean) - Method in class org.apache.rat.config.exclusion.plexus.MatchPatterns: Checks these MatchPatterns against a specified string.
matches(String, char[][], boolean) - Method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
matches(String, String[], boolean) - Method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
matches(Pattern) - Method in class org.apache.rat.header.HeaderMatcher: Deprecated.

Seeks a match in the last headers read.
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(IHeaders) - Method in class org.apache.rat.license.SimpleLicense
matches(DocumentName) - Method in class org.apache.rat.document.DocumentNameMatcher: Performs the match against the DocumentName.
MATCHES_ALL - Static variable in class org.apache.rat.document.DocumentNameMatcher: A matcher that matches all documents.
MATCHES_NONE - Static variable in class org.apache.rat.document.DocumentNameMatcher: A matcher that matches no documents.
matchPath(String, boolean) - Method in class org.apache.rat.config.exclusion.plexus.MatchPattern
matchPath(String, String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Tests whether or not a given path matches a given pattern.
matchPath(String, String, boolean) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Tests whether or not a given path matches a given pattern.
matchPath(String, String, String, boolean) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils
MatchPattern - Class in org.apache.rat.config.exclusion.plexus
MatchPattern(String, String) - Constructor for class org.apache.rat.config.exclusion.plexus.MatchPattern
MatchPatterns - Class in org.apache.rat.config.exclusion.plexus
matchPatternStart(String, boolean) - Method in class org.apache.rat.config.exclusion.plexus.MatchPattern
matchPatternStart(String, String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Tests whether or not a given path matches the start of a given pattern up to the first "**".
matchPatternStart(String, String, boolean) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Tests whether or not a given path matches the start of a given pattern up to the first "**".
MAVEN - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by Maven build system based project.
MavenGenerator - Class in org.apache.rat.tools: A simple tool to convert CLI options to a Maven Mojo base class.
MavenOption - Class in org.apache.rat.documentation.options: A representation of a CLI option as a Maven option
MavenOption(Option) - Constructor for class org.apache.rat.documentation.options.MavenOption: Constructor.
MEDIA_TYPE - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The media type for a document
MERCURIAL - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Mercurial source code control based tool.
merge(List<MatcherSet>) - Static method in interface org.apache.rat.config.exclusion.MatcherSet
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.
MISC - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The set of miscellaneous files generally left by editors and the like.
MISSING_HEADERS - Enum constant in enum org.apache.rat.commandline.StyleSheets: The missing header report style sheet
MKS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an MKS source code control based tool.
modifyEntry(Consumer<MatcherSet>, DocumentName, String) - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Allows modification of the file entry to match the MatchPattern format.
modifyEntry(Consumer<MatcherSet>, DocumentName, String) - Method in class org.apache.rat.config.exclusion.fileProcessors.BazaarIgnoreBuilder
modifyEntry(Consumer<MatcherSet>, DocumentName, String) - Method in class org.apache.rat.config.exclusion.fileProcessors.GitIgnoreBuilder: Convert the string entry.
modifyEntry(Consumer<MatcherSet>, DocumentName, String) - Method in class org.apache.rat.config.exclusion.fileProcessors.HgIgnoreBuilder
mvnOptions() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a map client option name to Maven Option.

N

name - Variable in class org.apache.rat.api.Document: The fully qualified name of this document
name - Variable in class org.apache.rat.documentation.options.AbstractOption: The name for the option
name() - Element in annotation type org.apache.rat.config.parameters.ConfigComponent: The common name for the component.
name() - Method in class org.apache.rat.documentation.velocity.License: Gets the name of this license.
NAME - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The name
nameMatcher - Variable in class org.apache.rat.api.Document: The path matcher used by this document
Naming - Class in org.apache.rat.tools: A simple tool to convert CLI options to Maven and Ant format and produce a CSV file.
NEGATION_PREFIX - Static variable in class org.apache.rat.config.exclusion.ExclusionUtils: Prefix used to negate a given pattern.
next() - Method in class org.apache.rat.utils.ExtendedIterator
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.
NONE - Enum constant in enum org.apache.rat.license.LicenseSetFactory.LicenseFilter: No licenses are returned.
NONE - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: No argument.
normalize(String) - Method in class org.apache.rat.document.DocumentName.FSInfo: Removes . and .. from filenames.
not() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new NotBuilder()
not(DocumentNameMatcher) - Static method in class org.apache.rat.document.DocumentNameMatcher: Performs a logical NOT on a DocumentNameMatcher.
Not - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Not - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Not() - Constructor for class org.apache.rat.anttasks.Not: Deprecated.
Not() - Constructor for class org.apache.rat.mp.Not: Deprecated.
NOT_MATCH_FILTER - Static variable in class org.apache.rat.config.exclusion.ExclusionUtils: A predicate that filters out lines that do NOT start with ExclusionUtils.NEGATION_PREFIX.
NotBuilder - Class in org.apache.rat.configuration.builders: A builder for the NotMatcher.
NotBuilder() - Constructor for class org.apache.rat.configuration.builders.NotBuilder
note() - Method in class org.apache.rat.documentation.velocity.License: Gets the space normalized note for the license.
NOTE - Static variable in class org.apache.rat.configuration.XMLConfig: note element name
NoteGuesser - Class in org.apache.rat.document.guesser: A class that determines if a file is a Note file. e.g.
NOTES - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A notes element
NOTES - Static variable in class org.apache.rat.help.Help: An array of notes to go at the bottom of the help output
NOTICE - Enum constant in enum org.apache.rat.api.Document.Type: A notice document (e.g.
NOTICES - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of note files
NOTIFICATION - Enum constant in enum org.apache.rat.ReportConfiguration.Processing: List file as present only
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

OFF - Enum constant in enum org.apache.rat.utils.Log.Level: Log nothing.
open(XsdWriter.Type, String...) - Method in class org.apache.rat.tools.xsd.XsdWriter: Opens (Starts) an element of the specified type along with its attributes.
openElement(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Writes the start of an element.
openElement(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Writes the start of an element.
openElement(XmlElements.Elements) - 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 - Variable in class org.apache.rat.documentation.options.AbstractOption: The actual UI-specific name for the option
option() - Method in enum org.apache.rat.commandline.Arg: Returns the first non-deprecated option from the group.
OPTION_COMPARATOR - Static variable in class org.apache.rat.OptionCollection: The Option comparator to sort the help
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.
OptionCollection.ArgumentType - Enum in org.apache.rat
options() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of command line options.
or(Collection<DocumentNameMatcher>) - Static method in class org.apache.rat.document.DocumentNameMatcher: Performs a logical OR across the collection of matchers.
or(DocumentNameMatcher...) - Static method in class org.apache.rat.document.DocumentNameMatcher: Performs a logical OR across the collection of matchers.
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: Classes that perform specific matching operations.
org.apache.rat.annotation - package org.apache.rat.annotation: Classes that update the files
org.apache.rat.anttasks - package org.apache.rat.anttasks: The base package for the RAT Apache Ant Task Library.
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.exclusion - package org.apache.rat.config.exclusion: Classes that manage the inclusion and exclusion of files.
org.apache.rat.config.exclusion.fileProcessors - package org.apache.rat.config.exclusion.fileProcessors: Custom file processors to handles exclusions defined in various formats.
org.apache.rat.config.exclusion.plexus - package org.apache.rat.config.exclusion.plexus: Code copied from https://github.com/codehaus-plexus/plexus-utils/ and modified for our purposes.
org.apache.rat.config.parameters - package org.apache.rat.config.parameters: Classes that manage information about parameters for builders, matchers and similar components.
org.apache.rat.config.results - package org.apache.rat.config.results: Contains utilities to validate the results.
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: Classes to build matchers
org.apache.rat.document - package org.apache.rat.document: The definitions of Documents and their analysers.
org.apache.rat.document.guesser - package org.apache.rat.document.guesser: Classes that attempt to determine if a file is a specific type of file.
org.apache.rat.documentation - package org.apache.rat.documentation: Contains tools for generating documentation.
org.apache.rat.documentation.options - package org.apache.rat.documentation.options: Contains ancillary enhanced options for the various RAT interfaces.
org.apache.rat.documentation.velocity - package org.apache.rat.documentation.velocity: Contains velocity based tools and accessories.
org.apache.rat.header - package org.apache.rat.header
org.apache.rat.help - package org.apache.rat.help: Classes to output help and help like information.
org.apache.rat.license - package org.apache.rat.license: Classes describing licenses
org.apache.rat.mp - package org.apache.rat.mp: The base package for the RAT Maven plugin.
org.apache.rat.plugin - package org.apache.rat.plugin
org.apache.rat.report - package org.apache.rat.report: Classes that generate the Rat report.
org.apache.rat.report.claim - package org.apache.rat.report.claim: Classes that manage claims (metrics) about files and categories of files.
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: Classes to handle writing well-formed XML documents.
org.apache.rat.tools - package org.apache.rat.tools: Contains ancillary tools for the RAT program including code generators and name harmonization code.
org.apache.rat.tools.xsd - package org.apache.rat.tools.xsd: Contains XSD file generation tools.
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: Classes that walk directory trees and return documents.
OrMatcher - Class in org.apache.rat.analysis.matchers: A matcher that performs a logical OR across all the contained matchers.
OrMatcher(String, Collection<? extends IHeaderMatcher>, String) - Constructor for class org.apache.rat.analysis.matchers.OrMatcher: Constructs the matcher with the specified id from the enclosed matchers.
OrMatcher(Collection<? extends IHeaderMatcher>, String) - Constructor for class org.apache.rat.analysis.matchers.OrMatcher: Constructs the matcher 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 configuration.
output(IOSupplier<InputStream>, IOSupplier<OutputStream>) - Method in class org.apache.rat.Reporter: Outputs the report to the specified output using the stylesheet.
OUTPUT_ARCHIVE - Enum constant in enum org.apache.rat.commandline.Arg: Specifies the level of reporting detail for archive files.
OUTPUT_FAMILIES - Enum constant in enum org.apache.rat.commandline.Arg: Specifies the license families that should be included in the output.
OUTPUT_FILE - Enum constant in enum org.apache.rat.commandline.Arg: Specifies where the output should be written.
OUTPUT_LICENSES - Enum constant in enum org.apache.rat.commandline.Arg: Specifies the license definitions that should be included in the output.
OUTPUT_STANDARD - Enum constant in enum org.apache.rat.commandline.Arg: Specifies the level of reporting detail for standard files.
OUTPUT_STYLE - Enum constant in enum org.apache.rat.commandline.Arg: Defines the stylesheet to use.
outputDirectory - Variable in class org.apache.rat.mp.RatReportMojo: The output directory for the report.
OVERWRITE - Enum constant in enum org.apache.rat.utils.ReportingSet.Options

P

pad(int) - Method in class org.apache.rat.documentation.velocity.RatTool: Creates a string of spaces of the specified length.
parallelStream() - Method in class org.apache.rat.utils.ReportingSet
PARAMETER - Enum constant in enum org.apache.rat.config.parameters.ComponentType: A Parameter for example the "id" parameter found in every component
parameterType() - Element in annotation type org.apache.rat.config.parameters.ConfigComponent: For collections defines the enclosed type.
parseCommands(File, String[], Consumer<Options>) - Static method in class org.apache.rat.OptionCollection: Parses the standard options to create a ReportConfiguration.
parseCommands(File, String[], Consumer<Options>, boolean) - Static method in class org.apache.rat.OptionCollection: Parses the standard options to create a ReportConfiguration.
PATTERN - Static variable in class org.apache.rat.documentation.options.AbstractOption: The pattern to match CLI options in text
PATTERN_HANDLER_PREFIX - Static variable in class org.apache.rat.config.exclusion.plexus.SelectorUtils
PATTERN_HANDLER_SUFFIX - Static variable in class org.apache.rat.config.exclusion.plexus.SelectorUtils
patterns() - Method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
patterns() - Method in enum org.apache.rat.config.exclusion.StandardCollection: Returns combined and deduped collection of patterns.
PHRASE - Enum constant in enum org.apache.rat.utils.CasedString.StringCase: Phrase case tags phrases of words like 'phrase case'.
PLAIN - Enum constant in enum org.apache.rat.commandline.StyleSheets: The plain style sheet.
PRESENCE - Enum constant in enum org.apache.rat.ReportConfiguration.Processing: List all present licenses
printArgumentTypes() - Method in class org.apache.rat.help.Help: Prints the list of argument types to the writer.
printHelp() - Method in class org.apache.rat.help.Licenses: Print the help text with the version information.
printHelp(PrintWriter, String, String, Options, String) - Method in class org.apache.rat.help.AbstractHelp.RatHelpFormatter: Prints the help text.
printUsage(Options) - Method in class org.apache.rat.help.Help: Print the usage to the specific PrintWriter.
process(Consumer<MatcherSet>, DocumentName, DocumentName) - Method in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: Process by reading the file, creating a MatcherSet, and adding it to the matcherSets.
process(Consumer<MatcherSet>, DocumentName, DocumentName) - Method in class org.apache.rat.config.exclusion.fileProcessors.CVSIgnoreBuilder
process(Consumer<MatcherSet>, DocumentName, DocumentName) - Method in class org.apache.rat.config.exclusion.fileProcessors.GitIgnoreBuilder
process(Consumer<MatcherSet>, DocumentName, DocumentName) - Method in class org.apache.rat.config.exclusion.fileProcessors.HgIgnoreBuilder
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() - Method in class org.apache.rat.commandline.ArgumentContext: Process the arguments specified in this context.
processArgs(ArgumentContext) - Static method in enum org.apache.rat.commandline.Arg: Process the arguments.
PROCESSINGTYPE - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A processing type.
processLogLevel(CommandLine) - Static method in enum org.apache.rat.commandline.Arg: Process the log level setting.
PRODUCT - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The product identifier
project - Variable in class org.apache.rat.mp.AbstractRatMojo: Holds the maven-internal project to allow resolution of artifact properties during mojo runs.
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.

Q

qualifyPattern(DocumentName, String) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Modifies the MatchPattern formatted pattern argument by expanding the pattern and by adjusting the pattern to include the basename from the documentName argument.

R

RAT_DECOMPOSE_MATCHER_ON_USE - Enum constant in enum org.apache.rat.api.EnvVar: Log matcher decomposition when used.
RAT_DEFAULT_LOG_LEVEL - Enum constant in enum org.apache.rat.api.EnvVar: Sets the log level for the DefaultLog when it is constructed.
RAT_NO_GIT_GLOBAL_IGNORE - Enum constant in enum org.apache.rat.api.EnvVar: Ignore Git Global ignore file.
RAT_REPORT - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: The start of the RAT report
RatCheckException - Exception in org.apache.rat.mp: Exception thrown when plugin processing encounters an error not found in the core system.
RatCheckException(String) - Constructor for exception org.apache.rat.mp.RatCheckException
RatCheckMojo - Class in org.apache.rat.mp: Run RAT to perform a violation check.
RatCheckMojo() - Constructor for class org.apache.rat.mp.RatCheckMojo
RatDocumentAnalysisException - Exception in org.apache.rat.document
RatDocumentAnalysisException(String) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
RatDocumentAnalysisException(String, Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
RatDocumentAnalysisException(Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException
RatException - Exception in org.apache.rat.api
RatException() - Constructor for exception org.apache.rat.api.RatException
RatException(String) - Constructor for exception org.apache.rat.api.RatException
RatException(String, Throwable) - Constructor for exception org.apache.rat.api.RatException
RatException(Throwable) - Constructor for exception org.apache.rat.api.RatException
RatHeaderAnalysisException - Exception in org.apache.rat.analysis: Indicates exceptional condition during header analysis.
RatHeaderAnalysisException() - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
RatHeaderAnalysisException(String) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
RatHeaderAnalysisException(String, Throwable) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
RatHeaderAnalysisException(Throwable) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException
ratReport() - Method in class org.apache.rat.report.xml.XmlElements: Create the RAT report element.
RatReport - Interface in org.apache.rat.report: Interface that defines a RatReport.
RatReportMojo - Class in org.apache.rat.mp: Generates a report with RAT's output.
RatReportMojo() - Constructor for class org.apache.rat.mp.RatReportMojo
RatTool - Class in org.apache.rat.documentation.velocity: The Velocity RAT plugin that provides access to the RAT data.
RatTool() - Constructor for class org.apache.rat.documentation.velocity.RatTool: Constructor.
raw() - Method in interface org.apache.rat.analysis.IHeaders: Gets raw header as found in the document.
RCS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an RCS source code control based tool.
read() - Method in class org.apache.rat.analysis.HeaderCheckWorker: Read the input and perform the header check.
read() - Method in class org.apache.rat.header.LineNumberReader: Deprecated.
read(Reader) - Method in class org.apache.rat.configuration.XMLConfigurationReader: Read xml from a reader.
read(Reader) - Method in class org.apache.rat.header.HeaderMatcher: Deprecated.
read(URI...) - Method in class org.apache.rat.configuration.XMLConfigurationReader: Read the uris and extract the DOM information to create new objects.
reader() - Method in class org.apache.rat.api.Document: Reads the contents of this document.
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()
Regex - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Regex - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Regex() - Constructor for class org.apache.rat.anttasks.Regex: Deprecated.
Regex() - Constructor for class org.apache.rat.mp.Regex: Deprecated.
REGEX_FMT - Static variable in class org.apache.rat.config.exclusion.fileProcessors.AbstractFileProcessorBuilder: A String format pattern to print a regex string
REGEX_HANDLER_PREFIX - Static variable in class org.apache.rat.config.exclusion.plexus.SelectorUtils
RegexBuilder - Class in org.apache.rat.configuration.builders: A builder for the regex matcher.
RegexBuilder() - Constructor for class org.apache.rat.configuration.builders.RegexBuilder
remoteRepositories - Variable in class org.apache.rat.mp.RatReportMojo: Remote repositories used for the project.
remove() - Method in class org.apache.rat.utils.ExtendedIterator
remove(File) - Method in class org.apache.rat.Defaults.Builder: Removes a file from the list of configuration files to process.
remove(Object) - Method in class org.apache.rat.utils.ReportingSet
remove(String) - Method in class org.apache.rat.Defaults.Builder: Removes a file name from the list of configuration files to process.
remove(URI) - Method in class org.apache.rat.Defaults.Builder: Removes a file from the list of configuration files to process.
removeAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
removeApprovedLicenseCategories(Collection<String>) - Method in class org.apache.rat.ReportConfiguration: Removes a license family category from the list of approved licenses.
removeApprovedLicenseCategory(String) - Method in class org.apache.rat.ReportConfiguration: Adds a license family category to the list of approved licenses.
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.
removeArg(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Remove a key from the argument list.
removeArg(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Remove a key from the argument list.
removeIf(Predicate<? super T>) - Method in class org.apache.rat.utils.ReportingSet
removeKey(Arg) - Method in class org.apache.rat.anttasks.Report: Removes the values for the arg.
removeKey(Arg) - Method in class org.apache.rat.mp.AbstractRatMojo: Removes all values for an Arg.
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: Remove matched licenses based on a predicate.
removeNext() - Method in class org.apache.rat.utils.ExtendedIterator: Returns the next item and removes it from the iterator.
removeWhitespace(String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: "Flattens" a string by removing all whitespace (space, tab, linefeed, carriage return, and formfeed).
renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.rat.anttasks.Help.AntHelpFormatter
renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.rat.help.AbstractHelp.RatHelpFormatter
report(Document) - Method in class org.apache.rat.report.AbstractReport: Deprecated.

Empty default implementation.
report(Document) - Method in class org.apache.rat.report.claim.AbstractClaimReporter
report(Document) - Method in class org.apache.rat.report.claim.ClaimReporterMultiplexer
report(Document) - Method in class org.apache.rat.report.claim.LicenseAddingReport
report(Document) - Method in class org.apache.rat.report.claim.SimpleXmlClaimReporter
report(Document) - Method in interface org.apache.rat.report.RatReport: Performs the actual reporting on the given document.
Report - Class in org.apache.rat.anttasks: A basic Ant task that generates a report on all files specified by the nested resource collection(s).
Report - Class in org.apache.rat: The CLI based configuration object for report generation.
Report() - Constructor for class org.apache.rat.anttasks.Report: Constructor.
Report.AddLicenseHeaders - Class in org.apache.rat.anttasks: Deprecated.
use <editCopyright> amd <editOverwrite> instead.
Report.ApprovalFilter - Class in org.apache.rat.anttasks: Deprecated.
use listLicenses or listFamilies attributes.
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.
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.
required() - Element in annotation type org.apache.rat.config.parameters.ConfigComponent: If true this component can be a child of the containing component.
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
resetLogReporter() - Static method in class org.apache.rat.DeprecationReporter: Rests the consumer to the default consumer.
resolve(String) - Method in class org.apache.rat.document.ArchiveEntryName
resolve(String) - Method in class org.apache.rat.document.DocumentName: Creates a new DocumentName by adding the child to the current name.
resource - Variable in class org.apache.rat.configuration.builders.ChildContainerBuilder: The resource the builders came from if it was read from a resource
RESOURCE - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A resource element
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
rootFor(String) - Method in class org.apache.rat.document.DocumentName.FSInfo: Retrieves the root extracted from the name.
run(RatReport) - Method in interface org.apache.rat.report.IReportable: Adds the reportable to the RatReport.
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.
run(RatReport) - Method in class org.apache.rat.walker.FileListWalker
run(RatReport) - Method in class org.apache.rat.walker.IReportableListWalker

S

SCCS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a SCCS source code control based tool.
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.
segregateList(Set<String>, Set<String>, Iterable<String>) - Static method in class org.apache.rat.config.exclusion.MatcherSet.Builder: Adds to lists of qualified file patterns.
SelectorUtils - Class in org.apache.rat.config.exclusion.plexus
SEQUENCE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A sequence
SERENA_DIMENSIONS_10 - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Serena Dimensions V10 change control system based tool.
session - Variable in class org.apache.rat.mp.RatReportMojo: The local repository.
set(String) - Method in class org.apache.rat.mp.Regex: Deprecated.
set(String) - Method in class org.apache.rat.mp.Spdx: Deprecated.
set(String) - Method in class org.apache.rat.mp.Text: Deprecated.
setAddApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use licensesApproved child element.
setAddDefaultDefinitions(File) - Method in class org.apache.rat.anttasks.Report: Deprecated.
Use Config child element
setAddDefaultLicenses(boolean) - Method in class org.apache.rat.mp.AbstractRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead (note the change of state).
setAddLicense(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use editLicense attribute instead.
setAddLicense(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <editLicense> instead.
setAddLicenseHeaders(String) - Method in class org.apache.rat.mp.RatCheckMojo: Deprecated.
Use <editLicense> and <editOverwrite>.
setAddLicenseHeaders(Report.AddLicenseHeaders) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use editLicense and editOverwrite attributes
setAddLicenseHeaders(AddLicenseHeaders) - Method in class org.apache.rat.ReportConfiguration: Sets whether RAT should enable, disable, or force the adding of license headers.
setAll(All) - Method in class org.apache.rat.mp.Any: Deprecated.
setAny(Any) - Method in class org.apache.rat.mp.Any: Deprecated.
setApprovalPredicate(Predicate<ILicense>) - 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.
setArg(String, String) - Method in class org.apache.rat.anttasks.BaseAntTask: Set a key and value into the argument list.
setArg(String, String) - Method in class org.apache.rat.plugin.BaseRatMojo: Set a key and value into the argument list.
setBaseName(File) - Method in class org.apache.rat.document.DocumentName.Builder: Sets the basename from a File.
setBaseName(String) - Method in class org.apache.rat.document.DocumentName.Builder: Sets the baseName.
setBaseName(DocumentName) - Method in class org.apache.rat.document.DocumentName.Builder: Sets the basename from the DocumentName.Builder.name of the specified DocumentName.
setCharset(Charset) - Method in class org.apache.rat.api.MetaData: Sets the charset for the document.
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.
setClassName(String) - Method in class org.apache.rat.mp.HeaderMatcherSpecification: Deprecated.

Sets the license matchers class name.
setConfig(String) - Method in class org.apache.rat.plugin.BaseRatMojo: File names for system configuration.
setConfigs(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: File names for system configuration.
setConfigurationNoDefaults(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Ignore default configuration.
setConfigurationNoDefaults(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Ignore default configuration.
setCopyright(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use editCopyright attribute instead.
setCopyright(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.
setCopyright(Copyright) - Method in class org.apache.rat.mp.Any: Deprecated.
setCopyrightMessage(String) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use copyright attribute
setCopyrightMessage(String) - Method in class org.apache.rat.mp.RatCheckMojo: Deprecated.
Deprecated for removal since 0.17: Use <editCopyright> instead.
setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration: Sets the optional copyright message used if RAT is adding license headers.
setCounterMax(String) - Method in class org.apache.rat.plugin.BaseRatMojo: The acceptable maximum number for the specified counter.
setCounterMaxs(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: The acceptable maximum number for the specified counter.
setCounterMin(String) - Method in class org.apache.rat.plugin.BaseRatMojo: The minimum number for the specified counter.
setCounterMins(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: The minimum number for the specified counter.
setDocumentType(Document.Type) - Method in class org.apache.rat.api.MetaData: Sets the document type.
setDryRun(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: If set do not update the files but generate the reports.
setDryRun(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: If set do not update the files but generate the reports.
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.
setEditCopyright(String) - Method in class org.apache.rat.anttasks.BaseAntTask: The copyright message to use in the license headers.
setEditCopyright(String) - Method in class org.apache.rat.plugin.BaseRatMojo: The copyright message to use in the license headers.
setEditLicense(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Add the Apache-2.0 license header to any file with an unknown license that is not in the exclusion list.
setEditLicense(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Add the Apache-2.0 license header to any file with an unknown license that is not in the exclusion list.
setEditOverwrite(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Forces any changes in files to be written directly to the source files so that new files are not created.
setEditOverwrite(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Forces any changes in files to be written directly to the source files so that new files are not created.
setEnclosed(IHeaderMatcher.Builder) - Method in class org.apache.rat.configuration.builders.NotBuilder: Sets the enclosed matcher.
setEnd(String) - Method in class org.apache.rat.anttasks.Copyright: Deprecated.
setEnd(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder: Sets the end date.
setExclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.
setExcludeFile(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use inputExcludeFile attribute instead.
setExcludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputExcludeFile> instead.
setExcludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputExclude> instead.
setExpr(String) - Method in class org.apache.rat.anttasks.Regex: Deprecated.
setExpression(String) - Method in class org.apache.rat.configuration.builders.RegexBuilder: Sets the regex expression.
setExpression(String) - Method in class org.apache.rat.mp.Regex: Deprecated.
setFamily(String) - Method in class org.apache.rat.anttasks.License: Deprecated.
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.
setForce(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use editOverwrite attribute instead.
setForce(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <editOverwrite> instead.
setFormat(String) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use BaseAntTask.setStylesheet(String)
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.
setHelpLicenses(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Print information about registered licenses.
setHelpLicenses(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Print information about registered licenses.
setId(String) - Method in class org.apache.rat.anttasks.Family: Deprecated.
setId(String) - Method in class org.apache.rat.anttasks.License: Deprecated.
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.
setInclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.
setIncludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputInclude> instead.
setIncludesFile(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use inputIncludeFile attribute instead.
setIncludesFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeFile> instead.
setInputExclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Excludes files matching <Expression>.
setInputExcludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Reads <Expression> entries from a file.
setInputExcludeParsedScm(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Parse SCM based exclusion files to exclude specified files and directories.
setInputExcludeParsedScms(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Parse SCM based exclusion files to exclude specified files and directories.
setInputExcludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Excludes files matching <Expression>.
setInputExcludeSize(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Excludes files with sizes less than the number of bytes specified.
setInputExcludeSize(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Excludes files with sizes less than the number of bytes specified.
setInputExcludeStd(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Excludes files defined in standard collections based on commonly occurring groups.
setInputExcludeStds(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Excludes files defined in standard collections based on commonly occurring groups.
setInputFileFilter(IOFileFilter) - Method in class org.apache.rat.anttasks.Report: Deprecated.
setInputInclude(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Includes files matching <Expression>.
setInputIncludeFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Reads <Expression> entries from a file.
setInputIncludes(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Includes files matching <Expression>.
setInputIncludeStd(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Includes files defined in standard collections based on commonly occurring groups.
setInputIncludeStds(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Includes files defined in standard collections based on commonly occurring groups.
setInputSource(String) - Method in class org.apache.rat.plugin.BaseRatMojo: A file containing file names to process.
setInputSources(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: A file containing file names to process.
setInstance(Log) - Static method in class org.apache.rat.utils.DefaultLog: Sets the default log instance.
setIsDirectory(boolean) - Method in class org.apache.rat.api.MetaData: Set the directory flag.
setLevel(Log.Level) - Method in class org.apache.rat.utils.DefaultLog: Sets the level.
setLevel(Log.Level) - Method in interface org.apache.rat.utils.Log: Sets the log level.
setLicenseFamilies(SortedSet<ILicenseFamily>) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the set of license families to use during build.
setLicenseFamilies(SortedSet<ILicenseFamily>) - Method in class org.apache.rat.license.SimpleLicense.Builder
setLicenseFamiliesApproved(String) - Method in class org.apache.rat.plugin.BaseRatMojo: A comma separated list of approved license family IDs.
setLicenseFamiliesApprovedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Name of file containing comma separated lists of approved family IDs.
setLicenseFamiliesDenied(String) - Method in class org.apache.rat.plugin.BaseRatMojo: A comma separated list of denied License family IDs.
setLicenseFamiliesDeniedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Name of file containing comma separated lists of denied license IDs.
setLicenseFamilyCategory(String) - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
setLicenseFamilyCategory(String) - Method in class org.apache.rat.license.ILicenseFamily.Builder: Sets the license family category.
setLicenseFamilyName(String) - Method in class org.apache.rat.analysis.license.BaseLicense: Deprecated.
setLicenseFamilyName(String) - Method in class org.apache.rat.license.ILicenseFamily.Builder: Sets the license family name.
setLicenses(File) - Method in class org.apache.rat.anttasks.Report: Deprecated.
create a configuration file and use the <config> child element.
setLicenses(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <config> instead.
setLicenses(String[]) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <config> instead.
setLicensesApproved(String) - Method in class org.apache.rat.plugin.BaseRatMojo: A comma separated list of approved License IDs.
setLicensesApprovedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Name of file containing comma separated lists of approved License IDs.
setLicensesDenied(String) - Method in class org.apache.rat.plugin.BaseRatMojo: A comma separated list of denied License IDs.
setLicensesDeniedFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Name of file containing comma separated lists of the denied license IDs.
setListFamilies(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use outputFamilies attribute instead.
setListFamilies(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <outputFamilies> instead.
setListLicenses(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use outputLicenses attribute instead.
setListLicenses(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <outputLicenses> instead.
setLogLevel(Log.Level) - Method in class org.apache.rat.utils.ReportingSet: Sets the log level that the reporting set will log at.
setLogReporter(Consumer<Option>) - Static method in class org.apache.rat.DeprecationReporter: Sets the consumer that will do the reporting.
setMatch(boolean) - Method in class org.apache.rat.header.HeaderBean: Deprecated.
setMatcher(IHeaderMatcher) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the matcher.
setMatcher(IHeaderMatcher) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the matcher.
setMatcher(IHeaderMatcher.Builder) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the matcher from a builder.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the matcher from a builder.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.All: Deprecated.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.Any: Deprecated.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.License: Deprecated.
setMatcher(IHeaderMatcher.Builder) - Method in class org.apache.rat.mp.Not: Deprecated.
setMatcherMap(Map<String, IHeaderMatcher>) - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder: Set the Map of matcher ids to matcher instances.
setMax(ClaimStatistic.Counter, int) - Method in class org.apache.rat.config.results.ClaimValidator: Sets the max value for the specified counter.
setMediaType(MediaType) - Method in class org.apache.rat.api.MetaData: Sets the defined media type.
setMin(ClaimStatistic.Counter, int) - Method in class org.apache.rat.config.results.ClaimValidator: Sets the max value for the specified counter.
setMsgFormat(Function<T, String>) - Method in class org.apache.rat.utils.ReportingSet: Sets the function to generate the log message.
setName(File) - Method in class org.apache.rat.document.DocumentName.Builder: Sets the properties from the file.
setName(String) - Method in class org.apache.rat.anttasks.Family: Deprecated.
setName(String) - Method in class org.apache.rat.anttasks.License: Deprecated.
setName(String) - Method in class org.apache.rat.anttasks.Spdx: Deprecated.
setName(String) - Method in class org.apache.rat.configuration.builders.SpdxBuilder: Sets the name for the SPDX matcher.
setName(String) - Method in class org.apache.rat.document.DocumentName.Builder: Sets the name for this DocumentName relative to the baseName.
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.
setNoDefaultLicenses(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use configurationNoDefaults attribute instead.
setNoDefaultLicenses(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <configurationNoDefaults> instead.
setNot(Not) - Method in class org.apache.rat.mp.Any: Deprecated.
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.
setNotes(String) - Method in class org.apache.rat.anttasks.License: Deprecated.
setOut(File) - Method in class org.apache.rat.ReportConfiguration: Sets the OutputStream supplier to use the specified file.
setOut(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use outputFile attribute instead.
setOut(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <outputFile> instead.
setOut(IOSupplier<OutputStream>) - Method in class org.apache.rat.ReportConfiguration: Sets the supplier for the output stream.
setOutputArchive(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Specifies the level of detail in ARCHIVE file reporting.
setOutputArchive(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Specifies the level of detail in ARCHIVE file reporting.
setOutputFamilies(String) - Method in class org.apache.rat.anttasks.BaseAntTask: List the defined license families.
setOutputFamilies(String) - Method in class org.apache.rat.plugin.BaseRatMojo: List the defined license families.
setOutputFile(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Define the output file where to write a report to.
setOutputFile(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Define the output file where to write a report to.
setOutputLicenses(String) - Method in class org.apache.rat.anttasks.BaseAntTask: List the defined licenses.
setOutputLicenses(String) - Method in class org.apache.rat.plugin.BaseRatMojo: List the defined licenses.
setOutputStandard(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Specifies the level of detail in STANDARD file reporting.
setOutputStandard(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Specifies the level of detail in STANDARD file reporting.
setOutputStyle(String) - Method in class org.apache.rat.anttasks.BaseAntTask: XSLT stylesheet to use when creating the report.
setOutputStyle(String) - Method in class org.apache.rat.plugin.BaseRatMojo: XSLT stylesheet to use when creating the report.
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.anttasks.Copyright: Deprecated.
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.
setRegex(Regex) - Method in class org.apache.rat.mp.Any: Deprecated.
setRemoveApprovedLicense(String) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use licensesFamiliesDenied child element
setRemoveApprovedLicense(String[]) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use licenseFamiliesDenied element
setReportFile(File) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use outputFile element
setReportFile(File) - Method in class org.apache.rat.mp.RatCheckMojo: Deprecated.
Use 'out' property instead.
setReportOutputDirectory(File) - Method in class org.apache.rat.mp.RatReportMojo
setReportStyle(String) - Method in class org.apache.rat.mp.RatCheckMojo: Deprecated.
Use setStyleSheet or xml instead.
setResource(String) - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder: Reads a text file.
setRoot(String) - Method in class org.apache.rat.document.DocumentName.Builder: Sets the root for the DocumentName.
setScanHiddenDirectories(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.
setScanHiddenDirectories(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <inputIncludeStd> with 'HIDDEN_DIR' argument instead.
setSimpleText(String) - Method in class org.apache.rat.configuration.builders.TextBuilder: Sets the text to match.
setSpdx(Spdx) - Method in class org.apache.rat.mp.Any: Deprecated.
setStandardProcessing(ReportConfiguration.Processing) - Method in class org.apache.rat.ReportConfiguration: Sets the archive processing type.
setStart(String) - Method in class org.apache.rat.anttasks.Copyright: Deprecated.
setStart(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder: Sets the start date.
setStyleReport(boolean) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use BaseAntTask.setOutputStyle(String) and pass "xml" or "plain-rat".
setStylesheet(String) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use outputStyle attribute instead.
setStylesheet(String) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> instead.
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.
setStyleSheet(IOSupplier<InputStream>) - 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.
setText(String) - Method in class org.apache.rat.anttasks.Text: Deprecated.
setText(Text) - Method in class org.apache.rat.mp.Any: Deprecated.
setUseDefaultLicenses(boolean) - Method in class org.apache.rat.anttasks.Report: Deprecated.
use noDefaultLicenses attribute
setWorkingDirectory(DocumentName) - Method in class org.apache.rat.commandline.Converters.FileConverter: Sets the working directory for the conversion.
setXml(boolean) - Method in class org.apache.rat.anttasks.BaseAntTask: Deprecated.
Deprecated for removal since 0.17: Use outputStyle attribute with the 'xml' argument instead.
setXml(boolean) - Method in class org.apache.rat.plugin.BaseRatMojo: Deprecated.
Deprecated for removal since 0.17: Use <outputStyle> with the 'xml' argument instead.
SIMPLE - Enum constant in enum org.apache.rat.tools.xsd.XsdWriter.Type: A simple type
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: A claim reporter to write the XML document.
SimpleXmlClaimReporter(IXmlWriter) - Constructor for class org.apache.rat.report.claim.SimpleXmlClaimReporter: Constructor.
since() - Element in annotation type org.apache.rat.DeprecationReporter.Info: The common name for the component.
siteRenderer - Variable in class org.apache.rat.mp.RatReportMojo: Doxia Site Renderer component.
siteTool - Variable in class org.apache.rat.mp.RatReportMojo: SiteTool.
size() - Method in class org.apache.rat.utils.ReportingSet
skip - Variable in class org.apache.rat.mp.AbstractRatMojo: Will skip the plugin execution, e.g. for technical builds that do not take license compliance into account.
SNAKE - Enum constant in enum org.apache.rat.utils.CasedString.StringCase: Snake case tags strings like 'Snake_Case'.
source() - Method in class org.apache.rat.config.exclusion.plexus.MatchPattern
source() - Method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
SOURCE - Enum constant in enum org.apache.rat.commandline.Arg: Reads files to test from a file.
spdx() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new SpdxBuilder()
Spdx - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Spdx - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Spdx() - Constructor for class org.apache.rat.anttasks.Spdx: Deprecated.
Spdx() - Constructor for class org.apache.rat.mp.Spdx: Deprecated.
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: Matches an SPDX identifier.
spliterator() - Method in class org.apache.rat.utils.ReportingSet
STANDARD - Enum constant in enum org.apache.rat.api.Document.Type: A standard document.
STANDARD_PATTERNS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: A standard collection of generally accepted patterns to ignore.
STANDARD_PROCESSING - Static variable in class org.apache.rat.Defaults: The default STANDARD processing style.
STANDARD_SCMS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: A standard collection of SCMs.
StandardCollection - Enum in org.apache.rat.config.exclusion: Collection of standard excludes.
STANDARDCOLLECTION - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A standard collection name.
standardCollections() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of standard collections.
STANDARDS - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of standard files
startDocument() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter: Starts a document by writing a prologue.
startDocument() - Method in class org.apache.rat.report.xml.writer.XmlWriter: Starts a document by writing a prolog.
startReport() - Method in class org.apache.rat.report.AbstractReport: Deprecated.

Empty default implementation.
startReport() - Method in class org.apache.rat.report.claim.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.
startsWith(String) - Method in class org.apache.rat.config.exclusion.plexus.MatchPattern
staticDocumentNameMatcher() - Method in enum org.apache.rat.config.exclusion.StandardCollection: Returns the documentNameMatchSupplier if it exists.
statistic(String, int, String, boolean) - Method in class org.apache.rat.report.xml.XmlElements: Creates a statistic element.
STATISTIC - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A statistic entry
statistics() - Method in class org.apache.rat.report.xml.XmlElements: Creates a statistics element.
STATISTICS - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: A statistics element
Std() - Constructor for class org.apache.rat.anttasks.BaseAntTask.Std
stream() - Method in class org.apache.rat.utils.ReportingSet
stringUtils() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the StringUtils object in order to work with it in Velocity templates.
STYLESHEET - Enum constant in enum org.apache.rat.OptionCollection.ArgumentType: A style sheet.
styleSheets() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets the list of stylesheets.
StyleSheets - Enum in org.apache.rat.commandline: The enumeration of system defined stylesheets.
subSet(T, T) - Method in class org.apache.rat.utils.ReportingSet
SUBVERSION - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Subversion source code control based tool.
SURROUND_SCM - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Surround SCM source code control based tool.

T

tab() - Method in class org.apache.rat.documentation.velocity.RatTool: Gets a tab character.
tailSet(T) - Method in class org.apache.rat.utils.ReportingSet
test(DocumentName) - Method in class org.apache.rat.document.DocumentNameMatcher.FileFilterPredicate
test(DocumentName) - Method in class org.apache.rat.document.DocumentNameMatcher.MatchPatternsPredicate
test(DocumentName) - Method in class org.apache.rat.document.DocumentNameMatcher.NotPredicate
text() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new TextBuilder()
Text - Class in org.apache.rat.anttasks: Deprecated.
use configuration file.
Text - Class in org.apache.rat.mp: Deprecated.
use Configuration file to define licenses
Text() - Constructor for class org.apache.rat.anttasks.Text: Deprecated.
Text() - Constructor for class org.apache.rat.mp.Text: Deprecated.
TEXT_LIST_CONVERTER - Static variable in class org.apache.rat.commandline.Converters: Converts a comma separated list into an array of strings.
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.
TIMESTAMP - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: A timestamp
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.
toKebabForm(String) - Static method in class org.apache.rat.plugin.BaseRatMojo: Creates a kebab case name from a camel case name.
tokenize(String) - Method in class org.apache.rat.document.DocumentName.FSInfo: Tokenizes the string based on the directory separator of this DocumentName.
tokenizePathToString(String, String) - Static method in class org.apache.rat.config.exclusion.plexus.MatchPattern
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.exclusion.plexus.MatchPattern
toString() - Method in class org.apache.rat.config.exclusion.plexus.MatchPatterns
toString() - Method in class org.apache.rat.config.parameters.Description
toString() - Method in class org.apache.rat.configuration.builders.AbstractBuilder
toString() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
toString() - Method in class org.apache.rat.configuration.builders.CopyrightBuilder
toString() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder
toString() - Method in class org.apache.rat.configuration.builders.NotBuilder
toString() - Method in class org.apache.rat.configuration.builders.RegexBuilder
toString() - Method in class org.apache.rat.configuration.builders.SpdxBuilder
toString() - Method in class org.apache.rat.configuration.builders.TextBuilder
toString() - Method in class org.apache.rat.document.DocumentName.FSInfo: Gets the common name for the underlying file system.
toString() - Method in class org.apache.rat.document.DocumentName: Returns the localized file name.
toString() - Method in class org.apache.rat.document.DocumentNameMatcher.DecomposeData
toString() - Method in class org.apache.rat.document.DocumentNameMatcher.FileFilterPredicate
toString() - Method in class org.apache.rat.document.DocumentNameMatcher.MatchPatternsPredicate
toString() - Method in class org.apache.rat.document.DocumentNameMatcher.NotPredicate
toString() - Method in class org.apache.rat.document.DocumentNameMatcher
toString() - Method in class org.apache.rat.documentation.Exporter
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.mp.Family: Deprecated.
toString() - Method in class org.apache.rat.mp.License: 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.
traverse() - Method in class org.apache.rat.documentation.velocity.MatcherTree: Executes an in-order-traversal of the tree.
TRUE - Enum constant in enum org.apache.rat.config.AddLicenseHeaders: Add license headers to a '.new' file.
TXT - Enum constant in enum org.apache.rat.configuration.Format: A plain text file
TxtValue() - Constructor for class org.apache.rat.anttasks.BaseAntTask.TxtValue
type() - Element in annotation type org.apache.rat.config.parameters.ConfigComponent: The component type.
TYPE - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The document type

U

UNAPPROVED - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of unapproved files
UNAPPROVED_LICENSES - Enum constant in enum org.apache.rat.commandline.StyleSheets: The unapproved licenses report
unapprovedLicenses() - Method in class org.apache.rat.api.MetaData: Gets the stream of unapproved licenses that have been matched.
UNKNOWN - Enum constant in enum org.apache.rat.api.Document.Type: An unknown document type.
UNKNOWN - Enum constant in enum org.apache.rat.report.claim.ClaimStatistic.Counter: count of unknown files
UNKNOWN - Static variable in interface org.apache.rat.license.ILicenseFamily: The license family for unknown licenses
UnknownLicense - Class in org.apache.rat.analysis: An ILicense implementation that represents an unknown license.
unsupportedArgs() - Static method in class org.apache.rat.anttasks.BaseAntTask
unsupportedArgs() - Static method in class org.apache.rat.plugin.BaseRatMojo: Returns the list of unsupported args.
use() - Element in annotation type org.apache.rat.DeprecationReporter.Info: The component type.
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.
validate(ReportConfiguration) - Method in class org.apache.rat.anttasks.Report: validates the task's configuration.
value - Variable in class org.apache.rat.anttasks.BaseAntTask.TxtValue
value() - Element in annotation type org.apache.rat.config.parameters.MatcherBuilder: The common name for the component.
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.api.EnvVar: 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.exclusion.StandardCollection: 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.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.OptionCollection.ArgumentType: 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.report.xml.XmlElements.Attributes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.rat.report.xml.XmlElements.Elements: 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.tools.xsd.XsdWriter.Type: 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.api.EnvVar: 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.exclusion.StandardCollection: 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.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.OptionCollection.ArgumentType: 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.report.xml.XmlElements.Attributes: 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.xml.XmlElements.Elements: 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.tools.xsd.XsdWriter.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.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.
VENDOR - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: The vendor identifier
version() - Method in class org.apache.rat.report.xml.XmlElements: Creates the version element with all version attributes populated.
VERSION - Enum constant in enum org.apache.rat.report.xml.XmlElements.Attributes: A version string
VERSION - Enum constant in enum org.apache.rat.report.xml.XmlElements.Elements: The version of RAT being run
versionInfo - Variable in class org.apache.rat.help.AbstractHelp: The version info for this instance
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.
VSS - Enum constant in enum org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Visual Source Safe source code control based tool.

W

Walker - Class in org.apache.rat.walker: Abstract walker.
Walker(Document) - 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.
WARN - Enum constant in enum org.apache.rat.utils.Log.Level: Log warn only.
write(byte[]) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
write(byte[], int, int) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
write(int) - Method in class org.apache.rat.ReportConfiguration.NoCloseOutputStream
write(Writer) - Method in class org.apache.rat.configuration.XMLConfigurationWriter: Writes the configuration to the specified writer.
write(Writer) - Method in class org.apache.rat.tools.xsd.XsdGenerator: Writes the XSD to the output.
write(IXmlWriter) - Method in class org.apache.rat.configuration.XMLConfigurationWriter: Writes the configuration to an IXmlWriter instance.
write(XmlElements.Attributes, String) - Method in class org.apache.rat.report.xml.XmlElements: Write an attribute.
writeAttributes(List<AntOption>) - Method in class org.apache.rat.tools.AntDocumentation
writeElements(List<AntOption>) - Method in class org.apache.rat.tools.AntDocumentation
writer - Variable in class org.apache.rat.help.Help: The writer this instance writes to
writeSummary(Appendable) - Method in class org.apache.rat.Reporter: Writes a text summary of issues with the run.

X

XDG_CONFIG_HOME - Enum constant in enum org.apache.rat.api.EnvVar: Defines the XDG home.
XML - Enum constant in enum org.apache.rat.commandline.StyleSheets: The plain style sheet.
XML - Enum constant in enum org.apache.rat.configuration.Format: An XML file
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
XmlElements - Class in org.apache.rat.report.xml: Creates the elements in the XML report.
XmlElements(IXmlWriter) - Constructor for class org.apache.rat.report.xml.XmlElements: Constructor.
XmlElements.Attributes - Enum in org.apache.rat.report.xml: The attributes of elements in the report.
XmlElements.Elements - Enum in org.apache.rat.report.xml: The elements in the report.
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: Lightweight IXmlWriter implementation.
XmlWriter(Writer) - Constructor for class org.apache.rat.report.xml.writer.XmlWriter: Constructs an XmlWriter with the specified writer for output.
XsdGenerator - Class in org.apache.rat.tools.xsd: Generates the XSD for a configuration.
XsdGenerator() - Constructor for class org.apache.rat.tools.xsd.XsdGenerator
XsdWriter - Class in org.apache.rat.tools.xsd: A writer that writes XSD nodes.
XsdWriter(Writer) - Constructor for class org.apache.rat.tools.xsd.XsdWriter: Creates an XSD writer that wraps a standard Writer.
XsdWriter.Type - Enum in org.apache.rat.tools.xsd: Types of elements in the XSD

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