Index (Apache Creadur RAT::Core 0.19-SNAPSHOT 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 and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ABSENCE - Enum constant in enum class 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(UIOptionCollection<?>) - 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.
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(OptionGroup) - Method in class org.apache.rat.ui.UpdatableOptionGroupCollection: Adds an OptionGroup to the collection.
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(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
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.ui.ArgumentTracker: Add values to the key in the argument list.
addArg(UIOption<?>, String...) - Method in class org.apache.rat.ui.ArgumentTracker: 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.
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(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.
addIncludedMatcher(DocumentNameMatcher) - Method in class org.apache.rat.ReportConfiguration: Includes files that match a DocumentNameMatcher.
addIncludedPatterns(Iterable<String>) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Add the iterable of strings to the collection of file/directory patterns to ignore.
addIncludedPatterns(Iterable<String>) - Method in class org.apache.rat.ReportConfiguration: Add file patterns that are to be included.
additionalOptions() - Method in class org.apache.rat.ui.UIOptionCollection: Gets the additional Options understood by this collection.
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 Class in org.apache.rat.config: Value of addLicenseHeaders configuration option.
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
addOption(Option) - Method in class org.apache.rat.ui.UpdatableOptionGroup
addReportable(Reportable) - Method in class org.apache.rat.walker.ReportableListWalker.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(Reportable) - Method in class org.apache.rat.ReportConfiguration: Adds a Reportable as a source of files to scan.
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 - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: All the standard excludes combined.
ALL - Enum constant in enum class 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
any() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new AnyBuilder()
AnyBuilder - Class in org.apache.rat.configuration.builders: Constructs an Any matcher.
AnyBuilder() - Constructor for class org.apache.rat.configuration.builders.AnyBuilder
ApacheV2LicenseAppender - Class in org.apache.rat.annotation: Add an Apache License V2 license header to a document.
ApacheV2LicenseAppender() - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender: Create a license appender with the standard ASF license header.
ApacheV2LicenseAppender(String) - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender: Create a license appender with the given copyright line.
append(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Append the default license header to the supplied document.
append(Document) - Method in class org.apache.rat.report.xml.writer.XmlWriter
apply(String) - Method in class org.apache.rat.commandline.Converters.FileConverter: Applies the conversion function to the specified file name.
apply(BiConsumer<String, List<String>>) - Method in class org.apache.rat.ui.ArgumentTracker: Applies the consumer to each arg and list in turn.
APPROVAL - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The approval flag.
APPROVED - Enum constant in enum class org.apache.rat.license.LicenseSetFactory.LicenseFilter: Only approved licenses are returned.
APPROVED - Enum constant in enum class 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
ARCH - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an ARCH source code control based tool.
ARCHIVE - Enum constant in enum class 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.
ArchiveEntryName - Class in org.apache.rat.document: The DocumentName for an ArchiveEntry.
ArchiveEntryName(DocumentName, String) - Constructor for class org.apache.rat.document.ArchiveEntryName: Constucts an archive file name from an archive file document name and an entry name.
ARCHIVES - Enum constant in enum class 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 class org.apache.rat.commandline.StyleSheets: Gets the name of the XSLT file.
Arg - Enum Class in org.apache.rat.commandline: An enumeration of options that are recommended across all UIs.
ARG - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A generic argument.
Arg.StdMsgs - Class in org.apache.rat.commandline: Standard messages used in descriptions.
args() - Method in class org.apache.rat.ui.ArgumentTracker: 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, Options, String[]) - Constructor for class org.apache.rat.commandline.ArgumentContext: Creates a context with an empty configuration.
ArgumentContext(File, ReportConfiguration, Options, String[]) - Constructor for class org.apache.rat.commandline.ArgumentContext: Creates a context with the specified configuration.
ArgumentTracker - Class in org.apache.rat.ui: Tracks Arg values that are set and their values for conversion from native UI to Apache Commons command line values.
ArgumentTracker(UIOptionCollection<?>) - Constructor for class org.apache.rat.ui.ArgumentTracker: The arguments understood by the UI for the current report execution.
argumentType - Variable in class org.apache.rat.ui.UIOption: The argument type for this option.
as(CasedString.StringCase) - Method in class org.apache.rat.utils.CasedString: Converts this cased string into another format.
asFile() - Method in class org.apache.rat.document.ArchiveEntryName
asFile() - Method in class org.apache.rat.document.DocumentName: Creates a file from the fully qualified 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 class org.apache.rat.utils.CasedString.StringCase: Assembles segments into a String.
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 class org.apache.rat.report.xml.writer.XmlWriter: Writes an attribute of an element.
attributes(Node) - Static method in class org.apache.rat.configuration.XMLConfigurationReader: Get a map of Node attribute names to values.

B

BASE_OPTION_COLLECTION - Static variable in class org.apache.rat.OptionCollection: Deprecated.

The collection of UI Options.
BaseLicense - Class in org.apache.rat.analysis.license: Deprecated.
BaseLicense() - Constructor for class org.apache.rat.analysis.license.BaseLicense: Deprecated.
BAZAAR - Enum constant in enum class 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 class org.apache.rat.report.claim.ClaimStatistic.Counter: count of binary files
BINARY - Enum constant in enum class org.apache.rat.api.Document.Type: A binary file.
BITKEEPER - Enum constant in enum class 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.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.Reporter.Output.Builder
build() - Method in class org.apache.rat.ui.UIOption.Builder: Builds the UIOption.
build() - Method in class org.apache.rat.walker.ReportableListWalker.Builder: Build the reportable.
build(Object) - Static method in class org.apache.rat.config.parameters.DescriptionBuilder: Create the description for the object.
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 class 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() - Static method in class org.apache.rat.Reporter.Output
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.ReportableListWalker: 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
Builder() - Constructor for class org.apache.rat.Reporter.Output.Builder
Builder() - Constructor for class org.apache.rat.ui.UIOption.Builder: Constructor.
Builder(Supplier<UIOption.Builder<T, ?>>) - Constructor for class org.apache.rat.ui.UIOptionCollection.Builder: Constructor for the UI option collection 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: Deprecated.

Create an Options object from the list of defined Options.

C

CAMEL - Static variable in class org.apache.rat.utils.CasedString.StringCase: The camel case.
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: Creates a cased string by parsing the string argument for the specific case.
CasedString(CasedString.StringCase, String[]) - Constructor for class org.apache.rat.utils.CasedString: Creates a cased string of the specified case and segments
CasedString.StringCase - Class in org.apache.rat.utils: The definition of a String case.
cdata(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Writes CDATA content.
ChildContainerBuilder - Class in org.apache.rat.configuration.builders: Constructs a builder that contains other builders.
ChildContainerBuilder() - Constructor for class org.apache.rat.configuration.builders.ChildContainerBuilder: Empty default constructor.
children - Variable in class org.apache.rat.configuration.builders.ChildContainerBuilder: The list of builders that will build the enclosed matchers.
childrenOfType(ComponentType) - Method in class org.apache.rat.config.parameters.Description: Get all the children of a specific type
ClaimAggregator - Class in org.apache.rat.report.claim: The aggregator is used to create a numerical statistic of claims.
ClaimAggregator(ClaimStatistic) - Constructor for class org.apache.rat.report.claim.ClaimAggregator: Constructor.
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 Class in org.apache.rat.report.claim: The counter types
ClaimStatistic.SerDes - Class in org.apache.rat.report.claim: Serialize and deserialize the claim Statistic.
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.
cleanup(String) - Method in class org.apache.rat.ui.UIOption: Replaces CLI pattern options with implementation specific pattern options.
cleanupName(Option) - Method in class org.apache.rat.CLIOption
cleanupName(Option) - Method in class org.apache.rat.ui.UIOption: Provide means to wrap the given option depending on the UI-specific option implementation.
clear() - Method in class org.apache.rat.utils.ReportingSet
CLIBuilder() - Constructor for class org.apache.rat.CLIOption.CLIBuilder
CLIOption - Class in org.apache.rat: The CLI option definition.
CLIOption.CLIBuilder - Class in org.apache.rat: Builder for a CLI Option.
CLIOptionCollection - Class in org.apache.rat: The collection of CLI Options.
CLIOptionCollection() - Constructor for class org.apache.rat.CLIOptionCollection: Constructs the CLIOption collection.
close() - Method in class org.apache.rat.report.xml.writer.XmlWriter
closeDocument() - Method in class org.apache.rat.report.xml.writer.XmlWriter: Closes all pending elements.
closeElement() - Method in class org.apache.rat.report.xml.writer.XmlWriter: Closes the last element written.
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.
commandLineDescription() - Method in class org.apache.rat.commandline.ArgumentContext: Creates a visual description of the CommandLine.
comment(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Writes a comment.
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
ComponentType - Enum Class in org.apache.rat.config.parameters: Types of components
ConfigComponent - Annotation Interface in org.apache.rat.config.parameters: An annotation that marks a configuration component.
configuration(String, DocumentName) - Method in class org.apache.rat.Reporter.Output.Builder
configuration(XmlWriter, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a configuration report
configuration(ReportConfiguration) - Method in class org.apache.rat.Reporter.Output.Builder
CONFIGURATION - Enum constant in enum class org.apache.rat.commandline.Arg: Group of options that read a configuration file.
CONFIGURATION_NO_DEFAULTS - Enum constant in enum class 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
contains(Object) - Method in class org.apache.rat.utils.ReportingSet
contains(Option) - Method in class org.apache.rat.ui.UpdatableOptionGroupCollection: Returns true if the option is in any of the groups.
containsAll(Collection<?>) - Method in class org.apache.rat.utils.ReportingSet
content(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Writes content.
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()
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 class 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 pair of Converter and count.
COUNTER_MAX - Enum constant in enum class org.apache.rat.commandline.Arg: Option to specify an acceptable number of various counters.
COUNTER_MIN - Enum constant in enum class org.apache.rat.commandline.Arg: Option to specify an acceptable number of various counters.
COUNTERPATTERN - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A Counter pattern name
create() - Method in interface org.apache.rat.ui.spi.UIProvider
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.
create(OptionGroup) - Static method in class org.apache.rat.ui.UpdatableOptionGroup: Converts the group into an UpdatableOptionGroup if it is not already an instance
createConfiguration(ArgumentContext) - Static method in class org.apache.rat.OptionCollection: Deprecated.

Create the report configuration.
createConfiguredAnalyser(ReportConfiguration) - Static method in class org.apache.rat.analysis.AnalyserFactory: Creates a DocumentAnalyser from the report configuration.
createDefault() - Static method in class org.apache.rat.utils.DefaultLog: Creates a new instance of the default log.
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.
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(XmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a RatReport from the arguments.
createTransformer() - Static method in class org.apache.rat.utils.StandardXmlFactory: Create a transformer with no stylesheet.
createTransformer(InputStream) - Static method in class org.apache.rat.utils.StandardXmlFactory: Create a transformer with the specified stylesheet.
CVS - Enum constant in enum class 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 class 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 class 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(Option) - Method in class org.apache.rat.ui.UIOptionCollection: Gets the default value for the option.
defaultValue(Option, String) - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Specify the default values for an option.
defaultValue(Arg, String) - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Specify the default values for an Arg.
delete(File) - Static method in class org.apache.rat.utils.FileUtils: Deletes a file if it exists (ignoring all IO-related exceptions).
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 Interface in org.apache.rat: Annotation to provide deprecation information for Java8.
desc() - Method in enum class org.apache.rat.commandline.StyleSheets: Gets the description of the XSLT file.
desc() - Method in enum class org.apache.rat.config.exclusion.StandardCollection
desc() - Element in annotation interface org.apache.rat.config.parameters.ConfigComponent: The description of the component.
desc() - Method in enum class org.apache.rat.ReportConfiguration.Processing: Gets the description of the processing type.
description() - Method in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

Gets the description.
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 class 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.
deserialize(IOSupplier<InputStream>) - Method in class org.apache.rat.report.claim.ClaimStatistic.SerDes: Deserializes a ClaimStatistic from an input stream.
deserialize(IOSupplier<InputStream>, DocumentName) - Method in class org.apache.rat.ReportConfiguration.SerDes: Reads an input stream as an XML document and parses the report configuration from that.
deserialize(Node) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor.SerDes: Deserialize from XML Document node to ExclusionProcessor.
detectedLicense() - Method in class org.apache.rat.api.MetaData: Determines if a matching license has been detected.
DIR - Enum constant in enum class 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 class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A directory or archive.
dirSeparator() - Method in class org.apache.rat.document.DocumentName.FSInfo: Gets the directory separator.
disableOption(Option) - Method in class org.apache.rat.ui.UpdatableOptionGroup: Disable an option in the group.
displayName() - Method in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: Display name is capitalized and any underscores are replaced by spaces.
doBuild() - Method in class org.apache.rat.CLIOption.CLIBuilder
doBuild() - Method in class org.apache.rat.ui.UIOption.Builder: Executes the final build.
document(String, DocumentName) - Method in class org.apache.rat.Reporter.Output.Builder
document(XmlWriter, Document) - Static method in class org.apache.rat.report.xml.XmlElements: Creates a document element with attributes.
document(Document) - Method in class org.apache.rat.Reporter.Output.Builder
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 class org.apache.rat.report.xml.XmlElements.Elements: A document type entry.
DOCUMENT_TYPES - Enum constant in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: count of distinct document types
Document.Type - Enum Class in org.apache.rat.api: An enumeration of document types.
DocumentAnalyser - Interface in org.apache.rat.document: Analyses Documents.
documentation() - Method in enum class org.apache.rat.api.EnvVar: Gets the documentation for this EnvVar.
documentBuilder() - Static method in class org.apache.rat.utils.StandardXmlFactory: Creates a DocumentBuilder with reasonable security settings.
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(XmlWriter, String, int) - Static method in class org.apache.rat.report.xml.XmlElements: Creates a document type element.
DOT - Static variable in class org.apache.rat.utils.CasedString.StringCase: The dot case.
DRY_RUN - Enum constant in enum class org.apache.rat.commandline.Arg: Specifies that the run should not perform any updates to files.

E

ECLIPSE - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an Eclipse IDE based tool.
EDIT_ADD - Enum constant in enum class org.apache.rat.commandline.Arg: Defines options to add licenses to files.
EDIT_COPYRIGHT - Enum constant in enum class org.apache.rat.commandline.Arg: Defines options to add copyright to files.
EDIT_OVERWRITE - Enum constant in enum class org.apache.rat.commandline.Arg: Causes file updates to overwrite existing files.
emptyIterator() - Static method in class org.apache.rat.utils.ExtendedIterator: An empty Extended iterator
ENCODING - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The encoding for a text document.
endReport() - Method in class org.apache.rat.report.claim.ClaimAggregator
endReport() - Method in interface org.apache.rat.report.RatReport: Signals the end of execution for the report.
EnvVar - Enum Class in org.apache.rat.api: This enumeration contains and documents RAT-specific environment variables.
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 record class org.apache.rat.ReportConfiguration.IODescriptor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.apache.rat.ui.UIOption
equals(Object) - Method in class org.apache.rat.utils.CasedString
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 class org.apache.rat.utils.Log.Level: Log error only.
EXCLUDE - Enum constant in enum class org.apache.rat.commandline.Arg: Excludes files by expression.
EXCLUDE_FILE - Enum constant in enum class org.apache.rat.commandline.Arg: Excludes files based on the contents of a file.
EXCLUDE_PARSE_SCM - Enum constant in enum class org.apache.rat.commandline.Arg: Excludes files based on SCM exclusion file processing.
EXCLUDE_SIZE - Enum constant in enum class org.apache.rat.commandline.Arg: Excludes files if they are smaller than the given threshold.
EXCLUDE_STD - Enum constant in enum class 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 a Reportable that contains all the reportable objects.
ExclusionProcessor() - Constructor for class org.apache.rat.config.exclusion.ExclusionProcessor: Constructs the processor.
ExclusionProcessor.SerDes - Class in org.apache.rat.config.exclusion: Serializes and deserializes the ExclusionProcessor to an XML document.
ExclusionUtils - Class in org.apache.rat.config.exclusion: Utilities for exclusion processing.
execute() - Method in class org.apache.rat.Reporter: Executes the report and builds the output.
EXPRESSION - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

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.
extractKey(Option) - Static method in class org.apache.rat.ui.ArgumentTracker: Extract the core name from the option.
extractName(Option) - Static method in class org.apache.rat.ui.ArgumentTracker: Generates the CasedString for the specified option.
extractPattern(String, String) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils

F

FAIL - Enum constant in enum class org.apache.rat.utils.ReportingSet.Options
FALSE - Enum constant in enum class 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 class org.apache.rat.commandline.Arg: Option that specifies approved license families.
FAMILIES_APPROVED_FILE - Enum constant in enum class org.apache.rat.commandline.Arg: Option that specifies approved license families from a file.
FAMILIES_DENIED - Enum constant in enum class org.apache.rat.commandline.Arg: Option to list license families to remove from the approved list.
FAMILIES_DENIED_FILE - Enum constant in enum class org.apache.rat.commandline.Arg: Option to read a list of license families to remove from the approved list.
FAMILY - Enum constant in enum class 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 class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

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 class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

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 Reportable 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
fileProcessorBuilder() - Method in enum class org.apache.rat.config.exclusion.StandardCollection: Returns the fileProcessor if it exists.
FileUtils - Class in org.apache.rat.utils: A set of utilities to help process files.
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.
finalize() - Method in class org.apache.rat.analysis.matchers.SimpleTextMatcher
find(String) - Method in enum class org.apache.rat.commandline.Arg: Finds the element associated with the key within the element group.
findArg(String) - Static method in enum class org.apache.rat.commandline.Arg: Finds the Arg that contains an Option with the specified key.
findGroups(Option) - Method in class org.apache.rat.ui.UpdatableOptionGroupCollection: Gets ll the UpdatableOptionGroups that the option is in.
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.
FORCED - Enum constant in enum class org.apache.rat.config.AddLicenseHeaders: Add headers and overwrite the existing file.
forDisplayName(String) - Static method in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

Get the matching Argument type.
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(IOSupplier<InputStream>, IOSupplier<OutputStream>) - Method in class org.apache.rat.Reporter.Output: Formats the report to the specified output using the stylesheet.
format(ReportConfiguration) - Method in class org.apache.rat.Reporter.Output: Formats the report to the output and using the stylesheet found in the report configuration.
Format - Enum Class 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 interface org.apache.rat.DeprecationReporter.Info: The description of the component.
from(File) - Static method in enum class 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 class 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 class 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.
fsInfo() - Method in class org.apache.rat.document.DocumentName: Returns the FSInfo for this document name.
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

get(String) - Method in interface org.apache.rat.BuilderParams: Gets one of the contained methods by name.
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.ui.ArgumentTracker: Get the list of values for a key.
getArgName() - Method in class org.apache.rat.ui.UIOption: Gets the argument name if there is one.
getArgs() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the arguments that followed all options on the command line.
getArgType() - Method in class org.apache.rat.ui.UIOption: Gets the argument type if there is one.
getArgumentTypes() - Static method in class org.apache.rat.OptionCollection: Deprecated.
use OptionCollection.ArgumentType
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
getCasedName() - Method in class org.apache.rat.ui.UIOption: Gets the CasedString version of the name for the native UI.
getCategory() - Method in class org.apache.rat.license.ILicenseFamily.Builder: Gets the category that this builder is building.
getCharset() - Method in class org.apache.rat.api.MetaData: Gets the charset for the document.
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.
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.
getCommonName() - Method in class org.apache.rat.config.parameters.Description: Gets the common name for the matcher.
getConfiguration() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the configuration.
getConfiguration() - Method in class org.apache.rat.Reporter.Output
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: Gets the FSInfo for the default file system.
getDefaultMaxValue() - Method in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: Gets the default maximum value for the counter.
getDefaultMinValue() - Method in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: Gets the default minimum value for the counter.
getDefaultValue() - Method in class org.apache.rat.ui.UIOption: Return default value.
getDeprecated() - Method in class org.apache.rat.ui.UIOption: 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 enum class org.apache.rat.report.claim.ClaimStatistic.Counter: Gets the description of the counter.
getDescription() - Method in class org.apache.rat.ui.UIOption: Gets the description in implementation specific format.
getDescription(Option) - Method in class org.apache.rat.ui.UIOptionCollection: Gets the description for the Option.
getDirectorySeparator() - Method in class org.apache.rat.document.DocumentName: Returns the directory separator.
getDisableOptions() - Method in class org.apache.rat.ui.UpdatableOptionGroup: Gets the disabled options for this group.
getDisplayName() - Method in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

Gets the display name.
getDocument() - Method in class org.apache.rat.Reporter.Output: 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.
getEnclosed() - Method in class org.apache.rat.analysis.matchers.AbstractMatcherContainer: Retrieves the collection of matchers that comprise the children of this matcher.
getEnclosed() - Method in class org.apache.rat.analysis.matchers.NotMatcher
getEnclosed() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
getEnclosedBuilders() - Method in class org.apache.rat.configuration.builders.ChildContainerBuilder
getEnd() - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher: Gets the end date of the copyright.
getExample() - Method in class org.apache.rat.CLIOption
getExample() - Method in class org.apache.rat.ui.UIOption: Gets an example of how to use this option in the native UI.
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.
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
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 for the current thread.
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.
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.
getMappedOption(Option) - Method in class org.apache.rat.ui.UIOptionCollection: Gets the UIOption instance for the Option.
getMappedOptions() - Method in class org.apache.rat.ui.UIOptionCollection: Gets the Stream of UIOption implementations understood by this collection.
getMatcher() - Method in class org.apache.rat.analysis.UnknownLicense
getMatcher() - Method in interface org.apache.rat.license.ILicense: Get the header matcher for this license.
getMatcher() - Method in class org.apache.rat.license.SimpleLicense
getMatcherBuilder(String) - Static method in class org.apache.rat.configuration.MatcherBuilderTracker: Get the matching builder for the name.
getMax(ClaimStatistic.Counter) - Method in class org.apache.rat.config.results.ClaimValidator: Gets the max 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.
getMin(ClaimStatistic.Counter) - Method in class org.apache.rat.config.results.ClaimValidator: Gets the min 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 interface org.apache.rat.license.ILicense: Returns the name of this license.
getName() - Method in class org.apache.rat.license.SimpleLicense
getName() - Method in class org.apache.rat.ui.UIOption: Gets the implementation specific name for the native UI.
getNameFactory() - Method in class org.apache.rat.CLIOption.CLIBuilder
getNameFactory() - Method in class org.apache.rat.ui.UIOption.Builder: Returns a function to convert an Option to a CasedString that is the native name for the option.
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.
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.ui.UIOption: Gets the option this abstract option is wrapping.
getOptionCollection() - Method in interface org.apache.rat.ui.UI: Gets the OptionFactory configuration for this UI.
getOptionCollection() - Method in class org.apache.rat.ui.UIOption: Gets the AbstractOptionCollection that this option is a member of.
getOptionMap() - Method in class org.apache.rat.ui.UIOptionCollection: Gets a map client option name to the specified UIOption implementation.
getOptions() - Static method in enum class org.apache.rat.commandline.Arg: Gets the full set of options.
getOptions() - Method in class org.apache.rat.commandline.ArgumentContext: Gets the Options from the command line.
getOptions() - Method in class org.apache.rat.ui.UIOptionCollection: Gets an Options that contains the Options and OptionGroups are understood by this collection.
getOptions() - Method in class org.apache.rat.ui.UpdatableOptionGroup
getOptionValue(Option) - Method in class org.apache.rat.commandline.ArgumentContext: Gets the option value or null if it is not set on the command line.
getOptionValues(Option) - Method in class org.apache.rat.commandline.ArgumentContext: Gets the list of option values from the command line.
getOutput() - Method in class org.apache.rat.ReportConfiguration: Returns the output stream supplier.
getOutput() - Method in class org.apache.rat.Reporter: Gets the output from the last Reporter.execute() call or null if Reporter.execute() has not been called.
getOutputDescriptor() - Method in class org.apache.rat.ReportConfiguration: Returns the output IODescriptor.
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.
getParsedOptionValue(Option) - Method in class org.apache.rat.commandline.ArgumentContext: Gets the parsed option value from the command line.
getParsedOptionValue(Option, Supplier<T>) - Method in class org.apache.rat.commandline.ArgumentContext: Gets the parsed option value from the command line.
getParsedOptionValues(Option) - Method in class org.apache.rat.commandline.ArgumentContext: Gets the parsed option values from the command line.
getParsedOptionValues(Option, Supplier<List<T>>) - Method in class org.apache.rat.commandline.ArgumentContext: Gets the parsed option values from the command line.
getPath() - Method in class org.apache.rat.document.DocumentName: Gets the path of the document.
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.
getRefId() - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder.IHeaderMatcherProxy: Gets the matcher ID that this proxy references.
getReportable(File, ReportConfiguration) - Static method in class org.apache.rat.OptionCollection: Deprecated.

Creates a Reportable object from the directory name and ReportConfiguration object.
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.
getSegments() - Method in class org.apache.rat.utils.CasedString: Gets the segments of this cased string.
getSegments(String) - Method in class org.apache.rat.utils.CasedString.StringCase: Parses a String into segments.
getSelected(Arg) - Method in class org.apache.rat.ui.UIOptionCollection: Gets the selected Option for an Arg.
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
getSources() - Method in class org.apache.rat.ReportConfiguration: Gets a ReportListWalker.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 standard processing type.
getStart() - Method in class org.apache.rat.analysis.matchers.CopyrightMatcher: Gets the start date of the copyright.
getStatistic() - Method in class org.apache.rat.Reporter.Output: Get the claim statistics from the run.
getStyleSheet() - Method in enum class org.apache.rat.commandline.StyleSheets: Gets the IODescriptor for a style sheet.
getStyleSheet() - Method in class org.apache.rat.ReportConfiguration: Gets the IOSupplier with the style sheet.
getStyleSheet(String, DocumentName) - Static method in enum class org.apache.rat.commandline.StyleSheets: Gets the IODescriptor for a style sheet.
getStyleSheetDescriptor() - Method in class org.apache.rat.ReportConfiguration: Gets the IODescriptor with the 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.CLIOption
getText() - Method in class org.apache.rat.ui.UIOption: Return a string showing long and short options if they are available.
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.ui.UIOption: Gets the simple class name for the data type for this option.
getType(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Detect the type of document.
getUnsupportedOptions() - Method in class org.apache.rat.ui.UIOptionCollection: Gets the collection of unsupported Options.
getValue() - Method in enum class org.apache.rat.api.EnvVar: Gets the value for the EnvVar.
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 class 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.
GRADLE - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by Gradle build system based projects.
group() - Method in enum class 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.ui.UIOption: Determine if the enclosed option expects an argument.
hasArgs() - Method in class org.apache.rat.ui.UIOption: 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 record class org.apache.rat.ReportConfiguration.IODescriptor: Returns a hash code value for this object.
hashCode() - Method in class org.apache.rat.ui.UIOption
hashCode() - Method in class org.apache.rat.utils.CasedString
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
hasOption(String) - Method in class org.apache.rat.commandline.ArgumentContext: Determines if option was specified on the command line.
hasOption(Option) - Method in class org.apache.rat.commandline.ArgumentContext: Determines if option was specified on the command line.
hasSource() - Method in class org.apache.rat.ReportConfiguration: Returns true if the configuration has any sources defined.
hasStaticDocumentNameMatcher() - Method in enum class 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 for a license.
HeaderCheckWorker(IHeaderMatcher, Reader, int, UnmodifiableSortedSet<ILicense>, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker: Constructs a check worker for the license against the specified document.
HeaderCheckWorker(IHeaderMatcher, Reader, UnmodifiableSortedSet<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.
headSet(T) - Method in class org.apache.rat.utils.ReportingSet
Help - Class in org.apache.rat.help: The help output for the command line client.
Help(UIOptionCollection<?>, PrintStream) - Constructor for class org.apache.rat.help.Help: Creates a Help instance to print to the specified stream.
Help(UIOptionCollection<?>, 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: Deprecated.

The Help option
HELP_LICENSES - Enum constant in enum class 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.
helpFormatter - Variable in class org.apache.rat.help.AbstractHelp: The help formatter for this instance
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 class org.apache.rat.config.exclusion.StandardCollection: The hidden directories.
HIDDEN_FILE - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The hidden files.
highSurrogate(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns the high surrogate of a supplemental character
HOME - Enum constant in enum class org.apache.rat.api.EnvVar: Defines the user HOME.

I

ID - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The id.
IDEA - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by an IDEA IDE based tool.
IGNORE - Enum constant in enum class org.apache.rat.utils.ReportingSet.Options
IGNORED - Enum constant in enum class org.apache.rat.api.Document.Type: A generated document that is ignored.
IGNORED - Enum constant in enum class 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 class org.apache.rat.commandline.Arg: Excludes files by expression.
INCLUDE_FILE - Enum constant in enum class org.apache.rat.commandline.Arg: Includes files based on the contents of a file.
INCLUDE_STD - Enum constant in enum class 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 class org.apache.rat.utils.Log.Level: Log info only.
init() - Static method in class org.apache.rat.Defaults: Initialize the system configuration reader.
inputStream() - Method in class org.apache.rat.api.Document: Streams the document's contents.
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: Deprecated, for removal: This API element is subject to removal in a future version.
Not thread-safe. Use SPDXMatcherFactory.newInstance() to create per-thread instances instead. Will be removed in 1.0.0.
INSTANCE - Static variable in class org.apache.rat.analysis.UnknownLicense: The single instance of this class.
INTEGER - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

An Integer.
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.
IODescriptor(String, IOSupplier<T>) - Constructor for record class org.apache.rat.ReportConfiguration.IODescriptor: Creates an instance of a IODescriptor record class.
ioSupplier() - Method in record class org.apache.rat.ReportConfiguration.IODescriptor: Returns the value of the ioSupplier record component.
IS_DIRECTORY - Enum constant in enum class 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.
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
isContent(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character can be considered content.
isDeprecated() - Method in class org.apache.rat.ui.UIOption: 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.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.
isEmpty() - Method in enum class org.apache.rat.commandline.Arg: Determines if all the options have been removed from this argument.
isEmpty() - Method in class org.apache.rat.ui.UpdatableOptionGroup
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.
isHidden(String) - Static method in class org.apache.rat.config.exclusion.ExclusionUtils: Returns true if the filename represents a hidden file
isHighSurrogate(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns whether the given character is a high surrogate
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.
isInvalid(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is invalid.
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.
isLowSurrogate(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns whether the given character is a low surrogate
isMarkup(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character can be considered markup.
isMatch() - Method in class org.apache.rat.header.HeaderBean: Deprecated.
isName(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a valid name character as defined by production [4] in the XML 1.0 specification.
isNameStart(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a valid name start character as defined by production [5] in the XML 1.0 specification.
isNCName(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a valid NCName character as defined by production [5] in Namespaces in XML recommendation.
isNCNameStart(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a valid NCName start character as defined by production [4] in Namespaces in XML recommendation.
isNote(Document) - Static method in class org.apache.rat.document.guesser.NoteGuesser: Determines if the document is a note.
isNull() - Method in class org.apache.rat.utils.CasedString
isOutOfDate(File, File, int) - Static method in class org.apache.rat.config.exclusion.plexus.SelectorUtils: Returns dependency information on these two files.
isPubid(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a valid Pubid character as defined by production [13] in the XML 1.0 specification.
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.ui.UIOption: Determines if the option is required.
isSelected(Arg) - Method in class org.apache.rat.ui.UIOptionCollection: Checks if an Arg is selected.
isSet() - Method in enum class org.apache.rat.api.EnvVar: Determines if this EnvVar is set.
isSpace(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a space character as defined by production [3] in the XML 1.0 specification.
isSupplemental(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is a supplemental character.
isValid(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the specified character is valid.
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.
isValidIANAEncoding(String) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the encoding name is a valid IANA encoding.
isValidJavaEncoding(String) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true if the encoding name is a valid Java encoding.
isValidName(String) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Check to see if a string is a valid Name according to [5] in the XML 1.0 Recommendation
isValidNCName(String) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Check to see if a string is a valid NCName according to [4] from the XML Namespaces 1.0 Recommendation
isValidNmtoken(String) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Check to see if a string is a valid Nmtoken according to [7] in the XML 1.0 Recommendation
iterator() - Method in class org.apache.rat.utils.ReportingSet

K

KEBAB - Static variable in class org.apache.rat.utils.CasedString.StringCase: The Kebab case.
keyValue() - Method in class org.apache.rat.ui.UIOption: The key value for the option.

L

last() - Method in class org.apache.rat.utils.ReportingSet
LevelBuilder() - Constructor for class org.apache.rat.config.exclusion.fileprocessors.AbstractFileProcessorBuilder.LevelBuilder
license(XmlWriter, ILicense, boolean) - Static method in class org.apache.rat.report.xml.XmlElements: Creates a license element.
LICENSE - Enum constant in enum class org.apache.rat.config.parameters.ComponentType: A License, the top level component.
LICENSE - Enum constant in enum class 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 class org.apache.rat.report.claim.ClaimStatistic.Counter: count of license categories
LICENSE_CATEGORY - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Elements: A license category entry.
LICENSE_NAME - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Elements: A license name entry.
LICENSE_NAMES - Enum constant in enum class 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(XmlWriter, String, int) - Static 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 class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A license filter.
LICENSEID - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A license id.
licenseName(XmlWriter, String, int) - Static method in class org.apache.rat.report.xml.XmlElements: Creates a statistic element.
licenseReader() - Method in enum class 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 - Class in org.apache.rat.help: Generates text based documentation for Licenses, LicenceFamilies, and Matchers.
Licenses(UIOptionCollection<?>, 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 class org.apache.rat.commandline.Arg: Option that adds approved licenses to the list.
LICENSES_APPROVED_FILE - Enum constant in enum class org.apache.rat.commandline.Arg: Option that adds approved licenses from a file.
LICENSES_DENIED - Enum constant in enum class org.apache.rat.commandline.Arg: Option to remove licenses from the approved list.
LICENSES_DENIED_FILE - Enum constant in enum class 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 Class 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.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(PrintWriter, LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.Reporter.Output: Lists the licenses on the print writer.
listLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.ReportConfiguration: Set the level of licenses that should be output in the XML document.
listLicenses(LicenseSetFactory.LicenseFilter) - Method in class org.apache.rat.Reporter.Output: Lists the licenses on the output specified in the configuration.
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(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 class org.apache.rat.commandline.Arg: Specifies the log level to log messages at.
Log.Level - Enum Class 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 class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

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.
logParseException(ParseException, Option) - Method in class org.apache.rat.commandline.ArgumentContext: Logs a ParseException as a warning and the exception itself as a debug.
lowSurrogate(int) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns the low surrogate of a supplemental character

M

MAC - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The .DS_Store files on Mac computers.
main(String[]) - Static method in class org.apache.rat.Report: Processes the command line and builds a configuration and executes the report.
main(String[]) - Static method in class org.apache.rat.VersionInfo: Simple testing output.
makeCategory(String) - Static method in interface org.apache.rat.license.ILicenseFamily: Convert a potential category string into a category string of exactly 5 characters either by truncating the string or appending spaces as necessary.
makeInstance(Exception) - Static method in exception org.apache.rat.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.
markSupportedInputStream(InputStream) - Static method in class org.apache.rat.analysis.TikaProcessor: Ensures that the input stream supports mark.
MASK_CONTENT - Static variable in class org.apache.rat.report.xml.writer.XMLChar: Content character mask.
MASK_NAME - Static variable in class org.apache.rat.report.xml.writer.XMLChar: Name character mask.
MASK_NAME_START - Static variable in class org.apache.rat.report.xml.writer.XMLChar: Name start character mask.
MASK_NCNAME - Static variable in class org.apache.rat.report.xml.writer.XMLChar: NCName character mask.
MASK_NCNAME_START - Static variable in class org.apache.rat.report.xml.writer.XMLChar: NCName start character mask.
MASK_PUBID - Static variable in class org.apache.rat.report.xml.writer.XMLChar: Pubid character mask.
MASK_SPACE - Static variable in class org.apache.rat.report.xml.writer.XMLChar: Space character mask.
MASK_VALID - Static variable in class org.apache.rat.report.xml.writer.XMLChar: Valid character mask.
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 - Enum constant in enum class org.apache.rat.config.parameters.ComponentType: A Matcher
MATCHER - Static variable in class org.apache.rat.configuration.XMLConfig: matcher element name
MatcherBuilder - Annotation Interface 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 class org.apache.rat.configuration.Format
MatcherReader - Interface in org.apache.rat.configuration: An interface that describes the methods of a Matcher reader.
matcherRef() - Static method in interface org.apache.rat.analysis.IHeaderMatcher.Builder: Deprecated.
Use new MatcherRefBuilder()
MatcherRefBuilder - Class in org.apache.rat.configuration.builders: A reference matching Matcher builder.
MatcherRefBuilder() - Constructor for class org.apache.rat.configuration.builders.MatcherRefBuilder
MatcherRefBuilder.IHeaderMatcherProxy - Class in org.apache.rat.configuration.builders: A class that is a proxy to the actual matcher.
MATCHERS - Static variable in class org.apache.rat.configuration.XMLConfig: matchers element name
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.
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 class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by Maven build system based project.
MEDIA_TYPE - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The media type for a document.
MERCURIAL - Enum constant in enum class 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 class org.apache.rat.config.exclusion.StandardCollection: The set of miscellaneous files generally left by editors and the like.
MISSING_HEADERS - Enum constant in enum class org.apache.rat.commandline.StyleSheets: The missing header report style sheet.
mkDir(File) - Static method in class org.apache.rat.utils.FileUtils: Creates a directory if it does not exist.
mkPath(String...) - Method in class org.apache.rat.document.DocumentName.FSInfo: Creates a path separated by the directory separator.
MKS - Enum constant in enum class 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
multiplexer(XmlWriter, boolean, DocumentAnalyser, List<? extends RatReport>) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a RatReport that multiplexes the running of multiple RatReports

N

name - Variable in class org.apache.rat.api.Document: The fully qualified name of this document
name - Variable in class org.apache.rat.ui.UIOption: The name for the option.
name() - Element in annotation interface org.apache.rat.config.parameters.ConfigComponent: The common name for the component.
name() - Method in interface org.apache.rat.report.Reportable: Returns the DocumentName for the reportable.
name() - Method in record class org.apache.rat.ReportConfiguration.IODescriptor: Returns the value of the name record component.
name() - Method in interface org.apache.rat.ui.UI: Gets the common name of this UI.
name() - Method in class org.apache.rat.walker.FileListWalker
name() - Method in class org.apache.rat.walker.ReportableListWalker
name() - Method in class org.apache.rat.walker.Walker
NAME - Enum constant in enum class 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
NEGATION_PREFIX - Static variable in class org.apache.rat.config.exclusion.ExclusionUtils: Prefix used to negate a given pattern.
newInstance() - Static method in class org.apache.rat.analysis.matchers.SPDXMatcherFactory: Creates a new SPDXMatcherFactory instance.
next() - Method in class org.apache.rat.utils.ExtendedIterator
noDefault() - Method in class org.apache.rat.Defaults.Builder: Removes the default definitions from the list of files to process.
nodeListConsumer(NodeList, Consumer<Node>) - Static method in class org.apache.rat.configuration.XMLConfigurationReader: Applies the consumer to each node in the list.
NONE - Enum constant in enum class org.apache.rat.license.LicenseSetFactory.LicenseFilter: No licenses are returned.
NONE - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

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_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 - 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 class 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 class org.apache.rat.api.Document.Type: A notice document (e.g.
NOTICES - Enum constant in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: count of note files
NOTIFICATION - Enum constant in enum class 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.
NULL - Static variable in class org.apache.rat.utils.CasedString: A null cased string.

O

OFF - Enum constant in enum class org.apache.rat.utils.Log.Level: Log nothing.
OperationNotAllowedException - Exception in org.apache.rat.report.xml.writer: Thrown by XmlWriter 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.ui.UIOption: The actual UI-specific name for the option.
option() - Method in enum class org.apache.rat.commandline.Arg: Returns the first non-deprecated option from the group.
option() - Method in class org.apache.rat.ui.UIOption.Builder: Gets the option.
option(Option) - Method in class org.apache.rat.ui.UIOption.Builder: Sets the Option that the UIOption will be generated from.
OPTION_COMPARATOR - Static variable in class org.apache.rat.OptionCollection: Deprecated.

The Option comparator to sort the help.
OPTION_COMPARATOR - Static variable in class org.apache.rat.OptionCollectionParser: The Option comparator to sort the help.
optionCollection - Variable in class org.apache.rat.ui.UIOption: The AbstractOptionCollection associated with this AbstractOption.
optionCollection() - Method in class org.apache.rat.ui.UIOption.Builder: Gets the UIOptionCollection that the options will be added to.
optionCollection(UIOptionCollection<T>) - Method in class org.apache.rat.ui.UIOption.Builder: Sets the UIOptionCollection that the UIOptions will be added to.
OptionCollection - Class in org.apache.rat: Deprecated.
this class will be removed and all functionality distributed across other classes.
OptionCollection.ArgumentType - Enum Class in org.apache.rat: Deprecated.
OptionCollectionParser<T extends UIOption<T>> - Class in org.apache.rat: Uses the AbstractOptionCollection to parse the command line options.
OptionCollectionParser(UIOptionCollection<T>) - Constructor for class org.apache.rat.OptionCollectionParser: Constructor.
options() - Method in class org.apache.rat.ui.UpdatableOptionGroupCollection: Gets an Options object from this collection.
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.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.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.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.ui - package org.apache.rat.ui: Classes that support UI generation and interoperability.
org.apache.rat.ui.spi - package org.apache.rat.ui.spi: The SPI implementation for the UIs.
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_ARCHIVE - Enum constant in enum class org.apache.rat.commandline.Arg: Specifies the level of reporting detail for archive files.
OUTPUT_FAMILIES - Enum constant in enum class org.apache.rat.commandline.Arg: Specifies the license families that should be included in the output.
OUTPUT_FILE - Enum constant in enum class org.apache.rat.commandline.Arg: Specifies where the output should be written.
OUTPUT_LICENSES - Enum constant in enum class org.apache.rat.commandline.Arg: Specifies the license definitions that should be included in the output.
OUTPUT_STANDARD - Enum constant in enum class org.apache.rat.commandline.Arg: Specifies the level of reporting detail for standard files.
OUTPUT_STYLE - Enum constant in enum class org.apache.rat.commandline.Arg: Defines the stylesheet to use.
OVERWRITE - Enum constant in enum class org.apache.rat.utils.ReportingSet.Options

P

parallelStream() - Method in class org.apache.rat.utils.ReportingSet
PARAMETER - Enum constant in enum class org.apache.rat.config.parameters.ComponentType: A Parameter for example the "id" parameter found in every component
parameterType() - Element in annotation interface org.apache.rat.config.parameters.ConfigComponent: For collections defines the enclosed type.
parseCommandLine(Options, String[]) - Static method in class org.apache.rat.OptionCollectionParser: Parse the options into the command line.
parseCommands(File, String[]) - Method in class org.apache.rat.OptionCollectionParser: Parses the standard options to create a ReportConfiguration.
parseCommands(File, String[], Consumer<Options>) - Static method in class org.apache.rat.OptionCollection: Deprecated.

Parses the standard options to create a ReportConfiguration.
parseCommands(File, String[], Consumer<Options>, boolean) - Static method in class org.apache.rat.OptionCollection: Deprecated.

Parses the standard options to create a ReportConfiguration.
PASCAL - Static variable in class org.apache.rat.utils.CasedString.StringCase: The pascal case.
PATTERN - Static variable in class org.apache.rat.ui.UIOption: 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 class org.apache.rat.config.exclusion.StandardCollection: Returns combined and deduped collection of patterns.
PHRASE - Static variable in class org.apache.rat.utils.CasedString.StringCase: The phrase case.
PLAIN - Enum constant in enum class org.apache.rat.commandline.StyleSheets: The plain style sheet.
PRESENCE - Enum constant in enum class 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(ArgumentContext, UIOptionCollection<?>) - Static method in enum class org.apache.rat.commandline.Arg: Process the arguments.
processArgs(UIOptionCollection<?>) - Method in class org.apache.rat.commandline.ArgumentContext: Process the arguments specified in this context.
PROCESSINGTYPE - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A processing type.
processLogLevel(ArgumentContext, UIOptionCollection<?>) - Static method in enum class org.apache.rat.commandline.Arg: Process the log level setting.
PRODUCT - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The product identifier.
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 class org.apache.rat.api.EnvVar: Log matcher decomposition when used.
RAT_DEFAULT_LOG_LEVEL - Enum constant in enum class 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 class org.apache.rat.api.EnvVar: Ignore Git Global ignore file.
RAT_REPORT - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Elements: The start of the RAT report.
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: This exception is used to indicate error conditions during RAT runs.
RatException() - Constructor for exception org.apache.rat.api.RatException: Constructor.
RatException(String) - Constructor for exception org.apache.rat.api.RatException: Constructor with message only.
RatException(String, Throwable) - Constructor for exception org.apache.rat.api.RatException: Constructor with message and cause.
RatException(Throwable) - Constructor for exception org.apache.rat.api.RatException: Constructor with cause only.
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(XmlWriter) - Static 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.
raw() - Method in interface org.apache.rat.analysis.IHeaders: Gets raw header as found in the document.
RCS - Enum constant in enum class 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 and relies on the charset detection of the underlying Tika processor.
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_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
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.ui.ArgumentTracker: Remove a key from the argument list.
removeArg(UIOption<?>) - Method in class org.apache.rat.ui.ArgumentTracker: Remove a key from the argument list.
removedOptions() - Method in class org.apache.rat.ui.UpdatableOptionGroupCollection: Gets the set of removed Options from the collection.
removeIf(Predicate<? super T>) - Method in class org.apache.rat.utils.ReportingSet
removeLicenseCategory(String) - Method in class org.apache.rat.license.LicenseSetFactory: Removes a license family category (id) from 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).
rename(Option) - Method in class org.apache.rat.ui.UIOptionCollection: Extracts the UI based name string for an option.
renderOptions(StringBuffer, int, Options, int, int) - Method in class org.apache.rat.help.AbstractHelp.RatHelpFormatter
report(Document) - Method in class org.apache.rat.report.claim.AbstractClaimReporter
report(Document) - Method in class org.apache.rat.report.claim.LicenseAddingReport
report(Document) - Method in interface org.apache.rat.report.RatReport: Performs the actual reporting on the given document.
Report - Class in org.apache.rat: The CLI based configuration object for report generation.
Reportable - Interface in org.apache.rat.report
ReportableListWalker - Class in org.apache.rat.walker: A Reportable that walks a list of Reportables and executes the run on each.
ReportableListWalker.Builder - Class in org.apache.rat.walker: A Builder for the ListWalker.
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.IODescriptor<T> - Record Class in org.apache.rat: An IODescriptor comprises a name and an IOSupplier.
ReportConfiguration.Processing - Enum Class in org.apache.rat: The styles of processing for various categories of documents.
ReportConfiguration.SerDes - Class in org.apache.rat: Serializes the ReportConfiguration into an XML document that can be deserialized by the Serde.
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.
Reporter.Output - Class in org.apache.rat: The output from a report run.
Reporter.Output.Builder - Class in org.apache.rat
reportExclusions(Appendable) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor: Report the excluded files to the appendable object.
reportExclusions(Appendable) - Method in class org.apache.rat.ReportConfiguration: Report the excluded files to the appendable object.
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 Class 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 interface 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 class 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
reset() - Method in class org.apache.rat.ui.UpdatableOptionGroup: Reset the group so that all disabled options are re-enabled.
resetLogReporter() - Static method in class org.apache.rat.DeprecationReporter: Resets the consumer to the default consumer.
resetSelected() - Method in class org.apache.rat.ui.UIOptionCollection: Resets the groups in the Args so that they are unused and ready to detect the next set of arguments.
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 class 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.
roots() - Method in class org.apache.rat.document.DocumentName.FSInfo: Gets the array of roots for this file system.
run(RatReport) - Method in interface org.apache.rat.report.Reportable: 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 the archive 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.ReportableListWalker

S

SCCS - Enum constant in enum class 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
self() - Method in class org.apache.rat.ui.UIOption.Builder: Returns this builder cast to the builder type.
self() - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Returns this cast to <B> class.
serDes() - Method in class org.apache.rat.config.exclusion.ExclusionProcessor
serDes() - Method in class org.apache.rat.report.claim.ClaimStatistic
serDes() - Method in class org.apache.rat.ReportConfiguration: A serializer/deserializer for a ReportConfiguration.
SerDes() - Constructor for class org.apache.rat.config.exclusion.ExclusionProcessor.SerDes
SerDes() - Constructor for class org.apache.rat.report.claim.ClaimStatistic.SerDes
SerDes() - Constructor for class org.apache.rat.ReportConfiguration.SerDes
SERENA_DIMENSIONS_10 - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Serena Dimensions V10 change control system based tool.
serialize(Appendable) - Method in class org.apache.rat.report.claim.ClaimStatistic.SerDes: Serializes the claim statistic into an appendable.
serialize(Appendable) - Method in class org.apache.rat.ReportConfiguration.SerDes: Writes the configuration as an XML document to the appendable.
serialize(XmlWriter) - Method in class org.apache.rat.config.exclusion.ExclusionProcessor.SerDes: Serialize the ExclusionProcessor to XML writer.
serializeDocument(Document) - Static method in class org.apache.rat.utils.StandardXmlFactory: Write an XML document to a file.
setAddLicenseHeaders(AddLicenseHeaders) - Method in class org.apache.rat.ReportConfiguration: Sets whether RAT should enable, disable, or force the adding of license headers.
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.ui.ArgumentTracker: Set a key and value into the argument list.
setArg(UIOption<?>, String) - Method in class org.apache.rat.ui.ArgumentTracker: 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.
setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration: Sets the optional copyright message used if RAT is adding license headers.
setCounter(ClaimStatistic.Counter, int) - Method in class org.apache.rat.report.claim.ClaimStatistic: Increments the counts for the counter.
setDocumentType(Document.Type) - Method in class org.apache.rat.api.MetaData: Sets the document type.
setDryRun(boolean) - Method in class org.apache.rat.ReportConfiguration: Sets the dry run flag.
setDuplicateOption(ReportingSet.Options) - Method in class org.apache.rat.utils.ReportingSet: If set true attempts to duplicate will throw an IllegalArgumentException.
setEnclosed(IHeaderMatcher.Builder) - Method in class org.apache.rat.configuration.builders.NotBuilder: Sets the enclosed matcher.
setEnd(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder: Sets the end date.
setExpression(String) - Method in class org.apache.rat.configuration.builders.RegexBuilder: Sets the regex expression.
setFamily(String) - Method in interface org.apache.rat.license.ILicense.Builder: Set the family category for this license.
setFamily(String) - Method in class org.apache.rat.license.SimpleLicense.Builder: Set the family category for this license.
setFamilyCategory(String) - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
setFamilyName(String) - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
setFrom(Defaults) - Method in class org.apache.rat.ReportConfiguration: Adds the licenses and approved licenses from the defaults object to the configuration.
setFullText(String) - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense: Deprecated.

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

Sets the header pattern to be matched.
setId(String) - Method in class org.apache.rat.configuration.builders.AbstractBuilder: Set the id for the matcher.
setId(String) - Method in class org.apache.rat.configuration.builders.SpdxBuilder: Set the id for the matcher.
setId(String) - Method in interface org.apache.rat.license.ILicense.Builder: Sets the ID of the license.
setId(String) - Method in class org.apache.rat.license.SimpleLicense.Builder: Sets the ID of the license.
setInstance(Log) - Static method in class org.apache.rat.utils.DefaultLog: Sets the default log instance for the current thread.
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
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.
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.
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 min 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.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.
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.
setOutput(File) - Method in class org.apache.rat.ReportConfiguration: Sets the OutputStream supplier to use the specified file.
setOutput(ReportConfiguration.IODescriptor<OutputStream>) - Method in class org.apache.rat.ReportConfiguration: Sets the supplier for the output stream.
setOverwrite(boolean) - Method in class org.apache.rat.annotation.AbstractLicenseAppender: Set the force flag on this appender.
setOwner(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder: Sets the owner.
setPatterns(String[]) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense: Deprecated.
setRefId(String) - Method in class org.apache.rat.configuration.builders.MatcherRefBuilder: Constructs the MatcherReferenceBuilder using the provided reference id.
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.
setSimpleText(String) - Method in class org.apache.rat.configuration.builders.TextBuilder: Sets the text to match.
setStandardProcessing(ReportConfiguration.Processing) - Method in class org.apache.rat.ReportConfiguration: Sets the standard processing type.
setStart(String) - Method in class org.apache.rat.configuration.builders.CopyrightBuilder: Sets the start date.
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(ReportConfiguration.IODescriptor<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.
setWorkingDirectory(DocumentName) - Method in class org.apache.rat.commandline.Converters.FileConverter: Sets the working directory for the conversion.
simple(XmlWriter) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a simple claim reporter.
simpleJoiner(char) - Static method in class org.apache.rat.utils.CasedString.StringCase: A simple joiner that assembles a String from a collection of segments.
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.
since() - Element in annotation interface org.apache.rat.DeprecationReporter.Info: The common name for the component.
size() - Method in class org.apache.rat.utils.ReportingSet
SLASH - Static variable in class org.apache.rat.utils.CasedString.StringCase: The slash case.
SNAKE - Static variable in class org.apache.rat.utils.CasedString.StringCase: The 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 class 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()
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 class org.apache.rat.api.Document.Type: A standard document.
STANDARD_PATTERNS - Enum constant in enum class 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 class org.apache.rat.config.exclusion.StandardCollection: A standard collection of SCMs.
StandardCollection - Enum Class in org.apache.rat.config.exclusion: Collection of standard excludes.
STANDARDCOLLECTION - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A standard collection name.
STANDARDS - Enum constant in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: count of standard files
StandardXmlFactory - Class in org.apache.rat.utils: Factory to create standard XML objects.
startDocument() - Method in class org.apache.rat.report.xml.writer.XmlWriter: Starts a document by writing a prolog.
startElement(CharSequence) - Method in class org.apache.rat.report.xml.writer.XmlWriter: Writes the start of an element.
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
startsWithRootOrSeparator(String) - Method in class org.apache.rat.document.DocumentName.FSInfo: Determines if the candidate string starts with a root or directory separator as defined in this FSInfo.
staticDocumentNameMatcher() - Method in enum class org.apache.rat.config.exclusion.StandardCollection: Returns the documentNameMatchSupplier if it exists.
statistic(String, DocumentName) - Method in class org.apache.rat.Reporter.Output.Builder
statistic(ClaimStatistic) - Method in class org.apache.rat.Reporter.Output.Builder
statistic(XmlWriter, String, int, String, boolean) - Static method in class org.apache.rat.report.xml.XmlElements: Creates a statistic element.
STATISTIC - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Elements: A statistic entry.
statistics(XmlWriter, ClaimStatistic, ClaimValidator) - Static method in class org.apache.rat.report.xml.XmlElements: Creates a statistics element.
STATISTICS - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Elements: A statistics element.
stream() - Method in class org.apache.rat.utils.ReportingSet
StringCase(String, char) - Constructor for class org.apache.rat.utils.CasedString.StringCase: Constructs a String case for the common cases where the delimiter is not preserved in the segments.
StringCase(String, Predicate<Character>, boolean, Function<String[], String>) - Constructor for class org.apache.rat.utils.CasedString.StringCase: Constructs a StringCase
StringCase(String, Predicate<Character>, boolean, Function<String[], String>, UnaryOperator<String>) - Constructor for class org.apache.rat.utils.CasedString.StringCase: Constructs a StingCase.
STYLESHEET - Enum constant in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

A style sheet.
StyleSheets - Enum Class 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 class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Subversion source code control based tool.
supplemental(char, char) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Returns true the supplemental character corresponding to the given surrogates.
SURROUND_SCM - Enum constant in enum class org.apache.rat.config.exclusion.StandardCollection: The files and directories created by a Surround SCM source code control based tool.
SYSTEM_OUT - Static variable in class org.apache.rat.ReportConfiguration: The IODescriptor for System.out.

T

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_LIST_CONVERTER - Static variable in class org.apache.rat.commandline.Converters: Converts a comma separated list into a list 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 class 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: Generates a string from this cased string but with the desired case.
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.license.SimpleLicense
toString() - Method in class org.apache.rat.license.SimpleLicenseFamily: Deprecated.
toString() - Method in record class org.apache.rat.ReportConfiguration.IODescriptor: Returns a string representation of this record class.
toString() - Method in class org.apache.rat.utils.CasedString.StringCase
toString() - Method in class org.apache.rat.utils.CasedString
toString() - Method in class org.apache.rat.VersionInfo: Default string representation of the implementation information from the package.
toString(Option) - Static method in class org.apache.rat.commandline.ArgumentContext: Gets a logging/debug string describing the Option.
trim(String) - Static method in class org.apache.rat.report.xml.writer.XMLChar: Trims space characters as defined by production [3] in the XML 1.0 specification from both ends of the given string.
TRUE - Enum constant in enum class org.apache.rat.config.AddLicenseHeaders: Add license headers to a '.new' file.
TXT - Enum constant in enum class org.apache.rat.configuration.Format: A plain text file
type() - Element in annotation interface org.apache.rat.config.parameters.ConfigComponent: The component type.
TYPE - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The document type.

U

UI<T extends UIOption<T>> - Interface in org.apache.rat.ui
uiOption(Option) - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Add an Option to the collection as a UIOption.
UIOption<T extends UIOption<T>> - Class in org.apache.rat.ui: Abstract class that provides the framework for UI-specific RAT options.
UIOption(UIOption.Builder<T, ?>) - Constructor for class org.apache.rat.ui.UIOption: Constructor.
UIOption.Builder<T extends UIOption<T>,B extends UIOption.Builder<T,B>> - Class in org.apache.rat.ui: The abstract UIOption Builder.
UIOptionCollection<T extends UIOption<T>> - Class in org.apache.rat.ui: A collection of options supported by the UI.
UIOptionCollection(UIOptionCollection.Builder<T, ?>) - Constructor for class org.apache.rat.ui.UIOptionCollection: Construct the UIOptionCollection from the builder.
UIOptionCollection.Builder<T extends UIOption<T>,B extends UIOptionCollection.Builder<T,B>> - Class in org.apache.rat.ui: Builder for a UIOptionCollection.
uiOptions(Option...) - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Add multiple Option instances to the collection as UIOptions.
UIProvider - Interface in org.apache.rat.ui.spi
UNAPPROVED - Enum constant in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: count of unapproved files
UNAPPROVED_LICENSES - Enum constant in enum class 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 class org.apache.rat.api.Document.Type: An unknown document type.
UNKNOWN - Enum constant in enum class 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.
unsupported(Option) - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Register an Option as unsupported.
unsupported(Arg) - Method in class org.apache.rat.ui.UIOptionCollection.Builder: Register multiple Options as unsupported.
unsupportedOptions() - Method in class org.apache.rat.ui.UpdatableOptionGroupCollection: Gets the unsupported options If multiple options from the a group are disabled they will be added to the options in a group together.
unsupportedRatOptions - Variable in class org.apache.rat.ui.UIOptionCollection.Builder: The list of unsupported RAT options.
UpdatableOptionGroup - Class in org.apache.rat.ui: An implementation of Apache Commons CLI OptionGroup that allows options to be removed (disabled).
UpdatableOptionGroupCollection - Class in org.apache.rat.ui: A collection of UpdatableOptionGroups.
UpdatableOptionGroupCollection() - Constructor for class org.apache.rat.ui.UpdatableOptionGroupCollection: Creates an empty collection.
use() - Element in annotation interface 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() - Method in class org.apache.rat.license.LicenseSetFactory
validate(Consumer<String>) - Method in class org.apache.rat.ReportConfiguration: Validates that the configuration is valid.
validator(XmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory: Creates a simple claim validator reporter
value() - Element in annotation interface org.apache.rat.config.parameters.MatcherBuilder: The common name for the component.
valueOf(String) - Static method in enum class org.apache.rat.api.Document.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.api.EnvVar: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.commandline.Arg: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.commandline.StyleSheets: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.config.AddLicenseHeaders: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.config.exclusion.StandardCollection: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.config.parameters.ComponentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.configuration.Format: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.license.LicenseSetFactory.LicenseFilter: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.report.xml.XmlElements.Attributes: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.report.xml.XmlElements.Elements: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.ReportConfiguration.Processing: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.utils.Log.Level: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.rat.utils.ReportingSet.Options: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.rat.api.Document.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.api.EnvVar: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.commandline.Arg: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.commandline.StyleSheets: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.config.AddLicenseHeaders: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.config.exclusion.StandardCollection: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.config.parameters.ComponentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.configuration.Format: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.license.LicenseSetFactory.LicenseFilter: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.OptionCollection.ArgumentType: Deprecated.

Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.report.claim.ClaimStatistic.Counter: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.report.xml.XmlElements.Attributes: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.report.xml.XmlElements.Elements: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.ReportConfiguration.Processing: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.utils.Log.Level: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.rat.utils.ReportingSet.Options: Returns an array containing the constants of this enum class, in the order they are declared.
VENDOR - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: The vendor identifier.
version(XmlWriter) - Static method in class org.apache.rat.report.xml.XmlElements: Creates the version element with all version attributes populated.
VERSION - Enum constant in enum class org.apache.rat.report.xml.XmlElements.Attributes: A version string.
VERSION - Enum constant in enum class 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 class 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 class org.apache.rat.utils.Log.Level: Log warn only.
write(Writer) - Method in class org.apache.rat.configuration.XMLConfigurationWriter: Writes the configuration to the specified writer.
write(XmlWriter) - Method in class org.apache.rat.configuration.XMLConfigurationWriter: Writes the configuration to an XmlWriter instance.
writeDocument(Document, File) - Static method in class org.apache.rat.utils.StandardXmlFactory: Write an XML document to a file.
writeFile(File, String) - Static method in class org.apache.rat.utils.FileUtils: Writes a text file containing the name of the file.
writeFile(File, String, Iterable<String>) - Static method in class org.apache.rat.utils.FileUtils: Writes a test file.
writeFile(File, String, String...) - Static method in class org.apache.rat.utils.FileUtils: Writes a test file.
writer - Variable in class org.apache.rat.help.Help: The writer this instance writes to
writeSummary(Appendable) - Method in class org.apache.rat.Reporter.Output: Writes a text summary of issues with the run.

X

XDG_CONFIG_HOME - Enum constant in enum class org.apache.rat.api.EnvVar: Defines the XDG home.
XHTML5 - Enum constant in enum class org.apache.rat.commandline.StyleSheets: Official HTML5 stylesheet.
XML - Enum constant in enum class org.apache.rat.commandline.StyleSheets: The pretty-printed XML style sheet.
XML - Enum constant in enum class org.apache.rat.configuration.Format: An XML file
XMLChar - Class in org.apache.rat.report.xml.writer: This class defines the basic XML character properties.
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.Attributes - Enum Class in org.apache.rat.report.xml: The attributes of elements in the report.
XmlElements.Elements - Enum Class 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: Requires a wrapper to be used safely in a multithreaded environment.
XmlWriter(Appendable) - Constructor for class org.apache.rat.report.xml.writer.XmlWriter: Constructs an XmlWriter with the specified writer for output.

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 and Interfaces|All Packages|Constant Field Values|Serialized Form