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

A

AbstractClaimReporter - Class in org.apache.rat.report.claim.impl

Abstract base implementation of AbstractReport.

AbstractClaimReporter() - Constructor for class org.apache.rat.report.claim.impl.AbstractClaimReporter

AbstractLicenseAppender - Class in org.apache.rat.annotation

Add a license header to a document.

AbstractLicenseAppender() - Constructor for class org.apache.rat.annotation.AbstractLicenseAppender

AbstractMonolithicDocument - Class in org.apache.rat.document.impl

Abstract base class for monolithic documents.

AbstractMonolithicDocument(String) - Constructor for class org.apache.rat.document.impl.AbstractMonolithicDocument

AbstractRatMojo - Class in org.apache.rat.mp

Abstract base class for Mojos, which are running Rat.

AbstractRatMojo() - Constructor for class org.apache.rat.mp.AbstractRatMojo

AbstractReport - Class in org.apache.rat.report

Abstract base class for deriving implementations of RatReport.

AbstractReport() - Constructor for class org.apache.rat.report.AbstractReport

AcademicFree21LicenseFamily - Class in org.apache.rat.license

AcademicFree21LicenseFamily() - Constructor for class org.apache.rat.license.AcademicFree21LicenseFamily

add(ResourceCollection) - Method in class org.apache.rat.anttasks.Report

Adds resources that will be checked.

add(IHeaderMatcher) - Method in class org.apache.rat.anttasks.Report

add(ILicenseFamily) - Method in class org.apache.rat.anttasks.Report

add(MetaData.Datum) - Method in class org.apache.rat.api.MetaData

Adds a new datum.

addConfiguredPattern(SubstringLicenseMatcher.Pattern) - Method in class org.apache.rat.anttasks.SubstringLicenseMatcher

addConfiguredStylesheet(Union) - Method in class org.apache.rat.anttasks.Report

Which stylesheet to use (only meaningful with format='styled').

addDefaultLicenseMatchers - Variable in class org.apache.rat.anttasks.Report

Whether to add the default list of license matchers.

addDefaultLicenseMatchers - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to add the default list of license matchers.

addEclipseDefaults(Log, boolean, Set<String>) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addIdeaDefaults(Log, boolean, Set<String>) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addingLicenses - Variable in class org.apache.rat.ReportConfiguration

addingLicensesForced - Variable in class org.apache.rat.ReportConfiguration

addLicenseHeaders - Variable in class org.apache.rat.anttasks.Report

Whether to add license headers.

AddLicenseHeaders() - Constructor for class org.apache.rat.anttasks.Report.AddLicenseHeaders

AddLicenseHeaders(String) - Constructor for class org.apache.rat.anttasks.Report.AddLicenseHeaders

AddLicenseHeaders - Enum in org.apache.rat.config

Value of addLicenseHeaders configuration option.

AddLicenseHeaders() - Constructor for enum org.apache.rat.config.AddLicenseHeaders

addLicenseHeaders - Variable in class org.apache.rat.mp.RatCheckMojo

Whether to add license headers; possible values are forced, true, and false (default).

addMavenDefaults(Log, boolean, Set<String>) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addPlexusAndScmDefaults(Log, boolean, Set<String>) - Static method in class org.apache.rat.mp.util.ExclusionHelper

addText(String) - Method in class org.apache.rat.anttasks.FullTextLicenseMatcher

aLicenseFamily() - Static method in class org.apache.rat.api.domain.LicenseFamilyBuilder

Begins to build a license family.

ALLOWED_CHARACTERS - Static variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

analyse(Document) - Method in class org.apache.rat.analysis.DefaultAnalyserFactory.DefaultAnalyser

analyse(Document) - Method in class org.apache.rat.analysis.DocumentHeaderAnalyser

analyse(Document) - Method in interface org.apache.rat.document.IDocumentAnalyser

analyse(Document) - Method in class org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer

analyse(Document) - Method in class org.apache.rat.policy.DefaultPolicy

analyser - Variable in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

analysers - Variable in class org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer

Apache20LicenseFamily - Class in org.apache.rat.license

Apache20LicenseFamily() - Constructor for class org.apache.rat.license.Apache20LicenseFamily

ApacheSoftwareLicense20 - Class in org.apache.rat.analysis.license

Matches Apache License, Version 2.0

ApacheSoftwareLicense20() - Constructor for class org.apache.rat.analysis.license.ApacheSoftwareLicense20

ApacheV2LicenseAppender - Class in org.apache.rat.annotation

Add an Apache License V2 license header to a document.

ApacheV2LicenseAppender() - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender

Create a license appender with the standard ASF license header.

ApacheV2LicenseAppender(String) - Constructor for class org.apache.rat.annotation.ApacheV2LicenseAppender

Create a license appender with the given copyright line.

append(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Append the default license header to the supplied document.

append(StringBuilder, String, int) - Method in class org.apache.rat.mp.HelpMojo

Append a description to the buffer by respecting the indentSize and lineLength parameters.

appender - Variable in class org.apache.rat.report.claim.util.LicenseAddingReport

AppliedApacheSoftwareLicense20 - Class in org.apache.rat.analysis.license

Matches an applied AL 2.0 License header, including a required initial copyright header line, conforming the template from the AL 2.0 license itself.

AppliedApacheSoftwareLicense20() - Constructor for class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20

AppliedApacheSoftwareLicense20(String) - Constructor for class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20

approveDefaultLicenses - Variable in class org.apache.rat.ReportConfiguration

approvedLicenseNames - Variable in class org.apache.rat.policy.DefaultPolicy

approvedLicenseNames - Variable in class org.apache.rat.ReportConfiguration

ARCHIVE_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.ArchiveGuesser

ARCHIVE_TYPE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

ARCHIVE_TYPE_READABLE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

ARCHIVE_TYPE_UNREADABLE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

ArchiveEntryDocument - Class in org.apache.rat.document.impl

ArchiveEntryDocument(File, byte[]) - Constructor for class org.apache.rat.document.impl.ArchiveEntryDocument

ArchiveGuesser - Class in org.apache.rat.document.impl.guesser

ArchiveGuesser() - Constructor for class org.apache.rat.document.impl.guesser.ArchiveGuesser

ArchiveWalker - Class in org.apache.rat.walker

Walks various kinds of archives files

ArchiveWalker(File, FilenameFilter) - Constructor for class org.apache.rat.walker.ArchiveWalker

Constructs a walker.

ArrayCharFilter - Class in org.apache.rat.header

ArrayCharFilter(char[]) - Constructor for class org.apache.rat.header.ArrayCharFilter

AS_IS_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.MITLicense

ASCII_CHAR_THRESHOLD - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

ASL20_LICENSE_DEFN - Static variable in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20

attachLicense(Writer, File, boolean, boolean, boolean, boolean, boolean, boolean) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Write document's content to writer attaching the license using the given flags as hints for where to put it.

attribute(CharSequence, CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

Writes an attribute of an element.

attribute(CharSequence, CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter

Writes an attribute of an element.

AUDIO_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

B

basedir - Variable in class org.apache.rat.mp.AbstractRatMojo

The base directory, in which to search for files.

basedir - Variable in class org.apache.rat.mp.FilesReportable

baseDirectory - Variable in class org.apache.rat.Report

BaseLicense - Class in org.apache.rat.analysis.license

BaseLicense() - Constructor for class org.apache.rat.analysis.license.BaseLicense

BaseLicense(MetaData.Datum, MetaData.Datum, String) - Constructor for class org.apache.rat.analysis.license.BaseLicense

BinaryGuesser - Class in org.apache.rat.document.impl.guesser

TODO: factor into MIME guesser and MIME->binary guesser

BinaryGuesser() - Constructor for class org.apache.rat.document.impl.guesser.BinaryGuesser

BOMInputStream - Class in org.apache.rat.annotation

Stripped down version of Commons IO 2.0's BOMInputStream.

BOMInputStream(InputStream) - Constructor for class org.apache.rat.annotation.BOMInputStream

BOMS - Static variable in class org.apache.rat.annotation.BOMInputStream

buffer - Variable in class org.apache.rat.analysis.license.FullTextMatchingLicense

buffer - Variable in class org.apache.rat.header.FilteringSequenceFactory

BUFFER_CAPACITY - Static variable in class org.apache.rat.header.FilteringSequenceFactory

build() - Method in class org.apache.rat.api.domain.LicenseFamilyBuilder

Builds a family.

build() - Method in class org.apache.rat.mp.HelpMojo

buildOptions() - Static method in class org.apache.rat.Report

BYTECODE_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

C

canGenerateReport() - Method in class org.apache.rat.mp.RatReportMojo

Returns, whether the report may be generated.

category - Variable in class org.apache.rat.api.domain.LicenseFamily

Names of the category containing this license family.

category - Variable in class org.apache.rat.api.domain.LicenseFamilyBuilder

Names of the category containing this license family.

category - Variable in enum org.apache.rat.api.domain.RatLicenseFamily

CDDL1_LICENSE_DEFN - Static variable in class org.apache.rat.analysis.license.CDDL1License

CDDL1_LICENSE_DEFN_ILLUMOS_STYLE - Static variable in class org.apache.rat.analysis.license.CDDL1License

CDDL1License - Class in org.apache.rat.analysis.license

Base CDDL 1.0 license.

CDDL1License() - Constructor for class org.apache.rat.analysis.license.CDDL1License

CDDL1LicenseFamily - Class in org.apache.rat.license

Base implementation for CDDL 1.0 licenses.

CDDL1LicenseFamily() - Constructor for class org.apache.rat.license.CDDL1LicenseFamily

CHARACTER_CODES - Static variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

CharFilter - Interface in org.apache.rat.header

CHARSET_FROM_FILE_ENCODING_OR_UTF8 - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

check(ClaimStatistic) - Method in class org.apache.rat.mp.RatCheckMojo

ClaimAggregator - Class in org.apache.rat.report.claim.impl

The aggregator is used to create a numerical statistic of claims.

ClaimAggregator(ClaimStatistic) - Constructor for class org.apache.rat.report.claim.impl.ClaimAggregator

ClaimReporterMultiplexer - Class in org.apache.rat.report.claim.util

ClaimReporterMultiplexer(IDocumentAnalyser, List<? extends RatReport>) - Constructor for class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

ClaimStatistic - Class in org.apache.rat.report.claim

This class provides a numerical overview about the report.

ClaimStatistic() - Constructor for class org.apache.rat.report.claim.ClaimStatistic

className - Variable in class org.apache.rat.mp.HeaderMatcherSpecification

The license matchers class name.

className - Variable in class org.apache.rat.mp.LicenseFamilySpecification

The license family's class name.

CLAUSE_DEFN - Static variable in class org.apache.rat.analysis.license.OASISLicense

clear(String) - Method in class org.apache.rat.api.MetaData

Removes all data matching the given name.

clear() - Method in class org.apache.rat.api.MetaData

Clears all data.

closeDocument() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

Closes all pending elements.

closeDocument() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter

Closes all pending elements.

closeElement() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

Closes the last element written.

closeElement() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter

Closes the last element written.

COMMENT_PREFIXES - Static variable in class org.apache.rat.mp.util.ScmIgnoreParser

COMPARATOR - Static variable in class org.apache.rat.walker.DirectoryWalker

compare(File, File) - Method in class org.apache.rat.walker.FileNameComparator

CompositeDocumentException - Exception in org.apache.rat.document

Indicates that the document is a composite archive and cannot be read.

CompositeDocumentException() - Constructor for exception org.apache.rat.document.CompositeDocumentException

CompositeDocumentException(String) - Constructor for exception org.apache.rat.document.CompositeDocumentException

ConfigurationHelper - Class in org.apache.rat.mp.util

ConfigurationHelper() - Constructor for class org.apache.rat.mp.util.ConfigurationHelper

ConfigurationUtil - Class in org.apache.rat.config

ConfigurationUtil() - Constructor for class org.apache.rat.config.ConfigurationUtil

consoleOutput - Variable in class org.apache.rat.mp.RatCheckMojo

Whether to output the names of files that have unapproved licenses to the console.

containsExtension(String, String[]) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

content(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

Writes content.

content(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter

Writes content.

contents - Variable in class org.apache.rat.document.impl.ArchiveEntryDocument

ContentType - Class in org.apache.rat.api

Describe the MIME content type of a resource.

ContentType(String, String, Map<String, String>) - Constructor for class org.apache.rat.api.ContentType

Constructs content types, performing an necessary conversions.

contentType - Variable in class org.apache.rat.api.MetaData

copyright - Variable in class org.apache.rat.annotation.ApacheV2LicenseAppender

COPYRIGHT_HEADER - Static variable in class org.apache.rat.analysis.license.TMF854LicenseHeader

COPYRIGHT_PATTERN - Static variable in class org.apache.rat.analysis.license.OASISLicense

COPYRIGHT_PATTERN_DEFN - Static variable in class org.apache.rat.analysis.license.OASISLicense

COPYRIGHT_PREFIX_PATTERN_DEFN - Static variable in class org.apache.rat.analysis.license.CopyrightHeader

COPYRIGHT_URL - Static variable in class org.apache.rat.analysis.license.W3CDocLicense

COPYRIGHT_URL - Static variable in class org.apache.rat.analysis.license.W3CLicense

CopyrightHeader - Class in org.apache.rat.analysis.license

Matches a typical Copyright header line only based on a regex pattern which allows for one (starting) year or year range, and a configurable copyright owner.

CopyrightHeader() - Constructor for class org.apache.rat.analysis.license.CopyrightHeader

CopyrightHeader(MetaData.Datum, MetaData.Datum, String) - Constructor for class org.apache.rat.analysis.license.CopyrightHeader

CopyrightHeader(MetaData.Datum, MetaData.Datum, String, String) - Constructor for class org.apache.rat.analysis.license.CopyrightHeader

copyrightMatch - Variable in class org.apache.rat.analysis.license.CopyrightHeader

copyrightMatch - Variable in class org.apache.rat.analysis.license.OASISLicense

copyrightMessage - Variable in class org.apache.rat.anttasks.Report

The copyright message.

copyrightMessage - Variable in class org.apache.rat.mp.RatCheckMojo

Copyright message to add to license headers.

copyrightMessage - Variable in class org.apache.rat.ReportConfiguration

copyrightOwner - Variable in class org.apache.rat.analysis.license.CopyrightHeader

copyrightPattern - Variable in class org.apache.rat.analysis.license.CopyrightHeader

createDefaultAnalyser(IHeaderMatcher) - Static method in class org.apache.rat.analysis.DefaultAnalyserFactory

createDefaultMatcher() - Static method in class org.apache.rat.Defaults

createReport(PrintWriter) - Method in class org.apache.rat.anttasks.Report

Writes the report to the given stream.

createReport(InputStream) - Method in class org.apache.rat.mp.AbstractRatMojo

Creates the report as a string.

createReport(Writer, InputStream) - Method in class org.apache.rat.mp.AbstractRatMojo

Writes the report to the given stream.

createStandardReport(IXmlWriter, ClaimStatistic, ReportConfiguration) - Static method in class org.apache.rat.report.xml.XmlReportFactory

currentAttributes - Variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

D

data - Variable in class org.apache.rat.api.MetaData

Only likely to be a small quantity of data so trade some performance for simplicity.

DATA_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

Datum(String, String) - Constructor for class org.apache.rat.api.MetaData.Datum

Constructs a datum.

DEFAULT_INITIAL_LINE_LENGTH - Static variable in class org.apache.rat.analysis.license.FullTextMatchingLicense

DEFAULT_LICENSE_FAMILIES - Static variable in class org.apache.rat.Defaults

DEFAULT_LINE_LENGTH - Static variable in class org.apache.rat.mp.HelpMojo

DEFAULT_MATCHERS - Static variable in class org.apache.rat.Defaults

The standard list of licenses to include in the reports.

DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES - Static variable in class org.apache.rat.analysis.HeaderCheckWorker

DEFAULT_PHRASES - Static variable in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

DefaultAnalyser(IHeaderMatcher) - Constructor for class org.apache.rat.analysis.DefaultAnalyserFactory.DefaultAnalyser

DefaultAnalyserFactory - Class in org.apache.rat.analysis

Creates default analysers.

DefaultAnalyserFactory() - Constructor for class org.apache.rat.analysis.DefaultAnalyserFactory

DefaultAnalyserFactory.DefaultAnalyser - Class in org.apache.rat.analysis

DefaultPolicy - Class in org.apache.rat.policy

DefaultPolicy() - Constructor for class org.apache.rat.policy.DefaultPolicy

Creates a policy that matches the default licenses.

DefaultPolicy(ILicenseFamily[], boolean) - Constructor for class org.apache.rat.policy.DefaultPolicy

DefaultPolicy(List<String>, boolean) - Constructor for class org.apache.rat.policy.DefaultPolicy

Defaults - Class in org.apache.rat

Utility class that holds constants shared by the CLI tool and the Ant tasks.

Defaults() - Constructor for class org.apache.rat.Defaults

no instances

detail - Variable in class org.apache.rat.mp.HelpMojo

If true, display all settable properties for each goal.

directory - Variable in enum org.apache.rat.config.SourceCodeManagementSystems

Technical directory of that SCM which contains SCM internals.

DirectoryWalker - Class in org.apache.rat.walker

Walks directories.

DirectoryWalker(File) - Constructor for class org.apache.rat.walker.DirectoryWalker

DirectoryWalker(File, FilenameFilter) - Constructor for class org.apache.rat.walker.DirectoryWalker

Constructs a walker.

DirectoryWalker(File, Pattern) - Constructor for class org.apache.rat.walker.DirectoryWalker

Document - Interface in org.apache.rat.api

DocumentAnalyserMultiplexer - Class in org.apache.rat.document.impl.util

DocumentAnalyserMultiplexer(IDocumentAnalyser[]) - Constructor for class org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer

documentCategoryMap - Variable in class org.apache.rat.report.claim.ClaimStatistic

DocumentHeaderAnalyser - Class in org.apache.rat.analysis

DocumentHeaderAnalyser(IHeaderMatcher) - Constructor for class org.apache.rat.analysis.DocumentHeaderAnalyser

DocumentImplUtils - Class in org.apache.rat.document.impl

DocumentImplUtils() - Constructor for class org.apache.rat.document.impl.DocumentImplUtils

doFirstLine(File, Writer, String, String) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Check first line for specified text and process.

DojoLicenseHeader - Class in org.apache.rat.analysis.license

DojoLicenseHeader() - Constructor for class org.apache.rat.analysis.license.DojoLicenseHeader

DOT - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

DOT - Static variable in class org.apache.rat.document.impl.guesser.ArchiveGuesser

DOT - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

DOT - Static variable in class org.apache.rat.document.impl.guesser.NoteGuesser

DOT_HTML - Static variable in class org.apache.rat.mp.RatReportMojo

E

ECLIPSE_DEFAULT_EXCLUDES - Static variable in class org.apache.rat.mp.util.ExclusionHelper

The Eclipse specific default excludes.

elementNames - Variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

elementsWritten - Variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

EMPTY_PATTERN_ARRAY - Static variable in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

EMPTY_STRING_ARRAY - Static variable in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

endReport() - Method in class org.apache.rat.report.AbstractReport

endReport() - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

endReport() - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

endReport() - Method in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

endReport() - Method in interface org.apache.rat.report.RatReport

EXCLUDE_CLI - Static variable in class org.apache.rat.Report

EXCLUDE_FILE_CLI - Static variable in class org.apache.rat.Report

excludes - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies files, which are excluded in the report.

excludesFile - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies a file, from which to read excludes.

excludesFileCharset - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies the include files character set.

excludeSubProjects - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to exclude subprojects.

ExclusionHelper - Class in org.apache.rat.mp.util

This class encapsulates the file/directory exclusion handling of RAT.

ExclusionHelper() - Constructor for class org.apache.rat.mp.util.ExclusionHelper

EXE_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

execute() - Method in class org.apache.rat.anttasks.Report

Generates the report.

execute() - Method in class org.apache.rat.mp.HelpMojo

execute() - Method in class org.apache.rat.mp.RatCheckMojo

Invoked by Maven to execute the Mojo.

execute() - Method in class org.apache.rat.mp.RatReportMojo

Called from Maven to invoke the plugin.

EXPECTS_AT_ECHO - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

EXPECTS_HASH_PLING - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

EXPECTS_MSVSSF_HEADER - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

EXPECTS_PACKAGE - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

EXPECTS_PHP_PI - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

EXPECTS_XML_DECL - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

expectsAtEcho(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

expectsHashPling(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

expectsMSVisualStudioSolutionFileHeader(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

expectsPackage(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

expectsPhpPI(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

expectsXMLDecl(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

EXT2TYPE - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

extensionMatches(String, String[]) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

F

factory - Variable in class org.apache.rat.header.HeaderMatcher

factory - Variable in class org.apache.rat.mp.RatReportMojo

FALSE - Static variable in class org.apache.rat.anttasks.Report.AddLicenseHeaders

FAMILY_APT - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

FAMILY_BAT - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

FAMILY_C - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

FAMILY_SGML - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

FAMILY_SH - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

FAMILY_VELOCITY - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

familyName - Variable in class org.apache.rat.license.SimpleLicenseFamily

fbIndex - Variable in class org.apache.rat.annotation.BOMInputStream

fbLength - Variable in class org.apache.rat.annotation.BOMInputStream

file - Variable in class org.apache.rat.document.impl.FileDocument

file - Variable in class org.apache.rat.document.impl.MonolithicFileDocument

file - Variable in class org.apache.rat.mp.FilesReportable.FileDocument

file - Variable in class org.apache.rat.walker.Walker

FILE_ENCODING - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

FILE_TYPE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

FILE_URL_PREFIX - Static variable in class org.apache.rat.document.impl.MonolithicFileDocument

FileDocument - Class in org.apache.rat.document.impl

Document wrapping a file of undetermined composition.

FileDocument(File) - Constructor for class org.apache.rat.document.impl.FileDocument

FileDocument() - Constructor for class org.apache.rat.mp.FilesReportable.FileDocument

FileNameComparator - Class in org.apache.rat.walker

FileNameComparator() - Constructor for class org.apache.rat.walker.FileNameComparator

files - Variable in class org.apache.rat.mp.FilesReportable

FilesReportable - Class in org.apache.rat.mp

Implementation of IReportable that traverses over a set of files.

FilesReportable(File, String[]) - Constructor for class org.apache.rat.mp.FilesReportable

FilesReportable.FileDocument - Class in org.apache.rat.mp

fillClaimStatistic(ClaimStatistic) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

filter - Variable in class org.apache.rat.header.FilteringSequenceFactory

filter(Reader) - Method in class org.apache.rat.header.FilteringSequenceFactory

filter - Variable in class org.apache.rat.walker.Walker

filtered - Variable in class org.apache.rat.header.ArrayCharFilter

FilteringSequenceFactory - Class in org.apache.rat.header

FilteringSequenceFactory(CharFilter) - Constructor for class org.apache.rat.header.FilteringSequenceFactory

FilteringSequenceFactory(int, CharFilter) - Constructor for class org.apache.rat.header.FilteringSequenceFactory

find() - Method in class org.apache.rat.annotation.BOMInputStream

findNamedChild(Node, String) - Method in class org.apache.rat.mp.HelpMojo

findSingleChild(Node, String) - Method in class org.apache.rat.mp.HelpMojo

finished - Variable in class org.apache.rat.analysis.HeaderCheckWorker

FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.ApacheSoftwareLicense20

FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.GPL1License

FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.GPL2License

FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.GPL3License

FIRST_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.MITLicense

FIRST_LICENSE_LINE_SHORT - Static variable in class org.apache.rat.analysis.license.ApacheSoftwareLicense20

firstBytes - Variable in class org.apache.rat.annotation.BOMInputStream

firstLine - Variable in class org.apache.rat.analysis.license.FullTextMatchingLicense

firstTime - Variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

FORCED - Static variable in class org.apache.rat.anttasks.Report.AddLicenseHeaders

format - Variable in class org.apache.rat.anttasks.Report

Which format to use.

Format() - Constructor for class org.apache.rat.anttasks.Report.Format

Format(String) - Constructor for class org.apache.rat.anttasks.Report.Format

fullText - Variable in class org.apache.rat.analysis.license.FullTextMatchingLicense

fullText - Variable in class org.apache.rat.anttasks.FullTextLicenseMatcher

FullTextLicenseMatcher - Class in org.apache.rat.anttasks

Adapts FullTextMatchingLicense to Ant's method naming conventions so it becomes easy to write text matching based license matchers inside an Ant build file.

FullTextLicenseMatcher() - Constructor for class org.apache.rat.anttasks.FullTextLicenseMatcher

FullTextMatchingLicense - Class in org.apache.rat.analysis.license

Accumulates all letters and numbers contained inside the header and compares it to the full text of a given license (after reducing it to letters and numbers as well).

FullTextMatchingLicense() - Constructor for class org.apache.rat.analysis.license.FullTextMatchingLicense

FullTextMatchingLicense(MetaData.Datum, MetaData.Datum, String, String) - Constructor for class org.apache.rat.analysis.license.FullTextMatchingLicense

G

generate(Sink, Locale) - Method in class org.apache.rat.mp.RatReportMojo

Writes the report to the Doxia sink.

GeneratedLicenseNotRequired - Class in org.apache.rat.analysis.generation

GeneratedLicenseNotRequired() - Constructor for class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

GeneratedLicenseNotRequired(Pattern[]) - Constructor for class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

GeneratedLicenseNotRequired(String[]) - Constructor for class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

get(String) - Method in class org.apache.rat.api.MetaData

Gets the first datum matching the given name.

getApprovedLicenseNames() - Method in class org.apache.rat.anttasks.Report

getApprovedLicenseNames() - Method in class org.apache.rat.policy.DefaultPolicy

getApprovedLicenseNames() - Method in class org.apache.rat.ReportConfiguration

Returns the set of approved license names.

getBOM() - Method in class org.apache.rat.annotation.BOMInputStream

getBundle(Locale) - Method in class org.apache.rat.mp.RatReportMojo

Returns the reports bundle

getCategory() - Method in class org.apache.rat.api.domain.LicenseFamily

Gets the name of the category containing this license family.

getCategory() - Method in enum org.apache.rat.api.domain.RatLicenseFamily

getCategoryName() - Method in class org.apache.rat.mp.RatReportMojo

Returns the reports category name.

getClassName() - Method in class org.apache.rat.mp.HeaderMatcherSpecification

Returns the license matchers class name.

getClassName() - Method in class org.apache.rat.mp.LicenseFamilySpecification

Returns the license familys class name.

getConfiguration() - Method in class org.apache.rat.mp.AbstractRatMojo

getConfiguration() - Method in class org.apache.rat.mp.RatCheckMojo

getContentType() - Method in class org.apache.rat.api.MetaData

Gets the content type for the subject.

getCopyrightMessage() - Method in class org.apache.rat.ReportConfiguration

getCopyRightOwner() - Method in class org.apache.rat.analysis.license.CopyrightHeader

getData() - Method in class org.apache.rat.api.MetaData

Gets all data.

getDefaultStyleSheet() - Static method in class org.apache.rat.Defaults

getDescription(Locale) - Method in class org.apache.rat.mp.RatReportMojo

Returns the reports description.

getDirectory(PrintStream) - Method in class org.apache.rat.Report

getDocumentCategoryMap() - Method in class org.apache.rat.report.claim.ClaimStatistic

getExcludesFromFile(Log, File) - Static method in class org.apache.rat.mp.util.ScmIgnoreParser

Parses excludes from the given SCM ignore file.

getExclusions() - Method in enum org.apache.rat.config.SourceCodeManagementSystems

If an ignore file exists it's added as

getExclusionsFromSCM(Log, File) - Static method in class org.apache.rat.mp.util.ScmIgnoreParser

Parse ignore files from all known SCMs that have ignore files.

getFamilyName() - Method in interface org.apache.rat.license.ILicenseFamily

getFamilyName() - Method in class org.apache.rat.license.SimpleLicenseFamily

getFileEncodingOrUTF8AsFallback() - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

getFirstLine(int) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Get the first line of the license header formatted for the given type of file.

getHeaderMatcher() - Method in class org.apache.rat.ReportConfiguration

Returns the header matcher.

getHeaderPattern() - Method in class org.apache.rat.header.HeaderBean

Gets the header pattern to be matched.

getIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems

Maybe null, check before with

getIndentLevel(String) - Static method in class org.apache.rat.mp.HelpMojo

Gets the indentation level of the specified line.

getLastLine(int) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Get the last line of the license header formatted for the given type of file.

getLicenseFamilyCategory() - Method in class org.apache.rat.analysis.license.BaseLicense

getLicenseFamilyName() - Method in class org.apache.rat.analysis.license.BaseLicense

getLicenseFileCodeMap() - Method in class org.apache.rat.report.claim.ClaimStatistic

getLicenseFileNameMap() - Method in class org.apache.rat.report.claim.ClaimStatistic

getLicenseHeader(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

getLicenseHeader(File) - Method in class org.apache.rat.annotation.ApacheV2LicenseAppender

getLicenseMatchers() - Method in class org.apache.rat.anttasks.Report

Flattens all nested matchers plus the default matchers (if required) into a single array.

getLine(int, String) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Get a line of the license header formatted for the given type of file.

getMediaType() - Method in class org.apache.rat.api.ContentType

Gets the media type, normalised to lower case.

getMetaData() - Method in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

getMetaData() - Method in interface org.apache.rat.api.Document

Gets data describing this resource.

getMetaData() - Method in class org.apache.rat.document.impl.AbstractMonolithicDocument

getMetaData() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument

getMetaData() - Method in class org.apache.rat.document.impl.FileDocument

getMetaData() - Method in class org.apache.rat.mp.FilesReportable.FileDocument

getName() - Method in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

getName() - Method in interface org.apache.rat.api.Document

getName() - Method in class org.apache.rat.api.domain.LicenseFamily

Gets the name uniquely identifying this family.

getName() - Method in enum org.apache.rat.api.domain.RatLicenseFamily

getName() - Method in class org.apache.rat.api.MetaData.Datum

Gets the name of the data type.

getName() - Method in class org.apache.rat.document.impl.AbstractMonolithicDocument

getName() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument

getName() - Method in class org.apache.rat.document.impl.FileDocument

getName() - Method in class org.apache.rat.mp.FilesReportable.FileDocument

getName(Locale) - Method in class org.apache.rat.mp.RatReportMojo

Returns the reports name.

getNotes() - Method in class org.apache.rat.analysis.license.BaseLicense

getNotes() - Method in class org.apache.rat.api.domain.LicenseFamily

Gets further information associated with the license family.

getNotes() - Method in enum org.apache.rat.api.domain.RatLicenseFamily

getNumApproved() - Method in class org.apache.rat.report.claim.ClaimStatistic

getNumGenerated() - Method in class org.apache.rat.report.claim.ClaimStatistic

getNumUnApproved() - Method in class org.apache.rat.report.claim.ClaimStatistic

getNumUnknown() - Method in class org.apache.rat.report.claim.ClaimStatistic

getOutputName() - Method in class org.apache.rat.mp.RatReportMojo

Returns the reports file name.

getParameters() - Method in class org.apache.rat.api.ContentType

Gets an immutable map containing all content type parameters with keys normalised to lower case.

getPatterns() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense

getPatterns() - Method in class org.apache.rat.anttasks.SubstringLicenseMatcher

getPatternsFromFile(File, String) - Method in class org.apache.rat.mp.AbstractRatMojo

getPlainStyleSheet() - Static method in class org.apache.rat.Defaults

getPluginExclusions() - Static method in enum org.apache.rat.config.SourceCodeManagementSystems

Calls SourceCodeManagementSystems.getExclusions() on each SCM to generate a global list of exclusions to be used during RAT runs.

getProject() - Method in class org.apache.rat.mp.AbstractRatMojo

getPropertyFromExpression(String) - Method in class org.apache.rat.mp.HelpMojo

getRatVersion() - Method in class org.apache.rat.mp.RatReportMojo

Searches for a Rat artifact in the dependency list and returns its version.

getRawReport() - Method in class org.apache.rat.mp.RatCheckMojo

getReportOutputDirectory() - Method in class org.apache.rat.mp.RatReportMojo

Returns the reports output directory.

getResources() - Method in class org.apache.rat.mp.AbstractRatMojo

Creates an iterator over the files to check.

getSingleChild(Node, String) - Method in class org.apache.rat.mp.HelpMojo

getSkinArtifactFile() - Method in class org.apache.rat.mp.RatReportMojo

Returns the skins artifact file.

getStyleSheet() - Method in class org.apache.rat.mp.RatCheckMojo

Returns the XSL stylesheet to be used for formatting the report.

getSubstring() - Method in class org.apache.rat.anttasks.SubstringLicenseMatcher.Pattern

getSubType() - Method in class org.apache.rat.api.ContentType

Gets the media sub type normalised to lower case

getType(File) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Detect the type of document.

getUnapprovedLicensesStyleSheet() - Static method in class org.apache.rat.Defaults

getValue() - Method in class org.apache.rat.api.MetaData.Datum

Data type value.

getValue(Node, String) - Method in class org.apache.rat.mp.HelpMojo

getValues() - Method in class org.apache.rat.anttasks.Report.AddLicenseHeaders

getValues() - Method in class org.apache.rat.anttasks.Report.Format

getValuesForHelp() - Static method in enum org.apache.rat.config.AddLicenseHeaders

goal - Variable in class org.apache.rat.mp.HelpMojo

The name of the goal for which to show help.

GPL1License - Class in org.apache.rat.analysis.license

License matches GPL1 or later.

GPL1License() - Constructor for class org.apache.rat.analysis.license.GPL1License

GPL1LicenseFamily - Class in org.apache.rat.license

Base implementation for GPLv1 or later.

GPL1LicenseFamily() - Constructor for class org.apache.rat.license.GPL1LicenseFamily

GPL2License - Class in org.apache.rat.analysis.license

License matches GPL2 or later.

GPL2License() - Constructor for class org.apache.rat.analysis.license.GPL2License

GPL2LicenseFamily - Class in org.apache.rat.license

Base implementation for GPLv2 or later.

GPL2LicenseFamily() - Constructor for class org.apache.rat.license.GPL2LicenseFamily

GPL3License - Class in org.apache.rat.analysis.license

License matches GPL3 or later.

GPL3License() - Constructor for class org.apache.rat.analysis.license.GPL3License

GPL3LicenseFamily - Class in org.apache.rat.license

Base implementation for GPLv3 or later.

GPL3LicenseFamily() - Constructor for class org.apache.rat.license.GPL3LicenseFamily

GuessUtils - Class in org.apache.rat.document.impl.guesser

GuessUtils() - Constructor for class org.apache.rat.document.impl.guesser.GuessUtils

H

handleApprovedLicenseClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

handleApprovedLicenseClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

handleDocumentCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

handleDocumentCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

handleHeaderCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

handleHeaderCategoryClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

handleLicenseFamilyNameClaim(String) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

handleLicenseFamilyNameClaim(String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

hasCopyrightPattern() - Method in class org.apache.rat.analysis.license.CopyrightHeader

hasFullText() - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense

hasIgnoreFile() - Method in enum org.apache.rat.config.SourceCodeManagementSystems

HEADER_SAMPLE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

HEADER_TYPE_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

HeaderBean - Class in org.apache.rat.header

HeaderBean() - Constructor for class org.apache.rat.header.HeaderBean

HeaderBean(Pattern, boolean) - Constructor for class org.apache.rat.header.HeaderBean

HeaderCheckWorker - Class in org.apache.rat.analysis

Reads from a stream to check license.

HeaderCheckWorker(Reader, IHeaderMatcher, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker

Convenience constructor wraps given Reader in a BufferedReader.

HeaderCheckWorker(BufferedReader, IHeaderMatcher, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker

HeaderCheckWorker(BufferedReader, int, IHeaderMatcher, Document) - Constructor for class org.apache.rat.analysis.HeaderCheckWorker

headerLinesToRead - Variable in class org.apache.rat.analysis.HeaderCheckWorker

HeaderMatcher - Class in org.apache.rat.header

Matches headers.

HeaderMatcher(CharFilter, int) - Constructor for class org.apache.rat.header.HeaderMatcher

HeaderMatcher(CharFilter, int, HeaderBean[]) - Constructor for class org.apache.rat.header.HeaderMatcher

headerMatcher - Variable in class org.apache.rat.ReportConfiguration

HeaderMatcherMultiplexer - Class in org.apache.rat.analysis.util

Delegates to an ordered set of matchers.

HeaderMatcherMultiplexer(List<IHeaderMatcher>) - Constructor for class org.apache.rat.analysis.util.HeaderMatcherMultiplexer

HeaderMatcherSpecification - Class in org.apache.rat.mp

Used to specify additional license matchers.

HeaderMatcherSpecification() - Constructor for class org.apache.rat.mp.HeaderMatcherSpecification

headerPattern - Variable in class org.apache.rat.header.HeaderBean

headers - Variable in class org.apache.rat.header.HeaderMatcher

HELP - Static variable in class org.apache.rat.Report

HelpMojo - Class in org.apache.rat.mp

Display help information on apache-rat-plugin.
Call mvn apache-rat:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.apache.rat.mp.HelpMojo

HIGH_BYTES_RATIO - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

I

IDEA_DEFAULT_EXCLUDES - Static variable in class org.apache.rat.mp.util.ExclusionHelper

The IDEA specific default excludes.

IDocumentAnalyser - Interface in org.apache.rat.document

ignoreErrors - Variable in class org.apache.rat.mp.RatCheckMojo

Will ignore rat errors and display a log message if any.

ignoreFile - Variable in enum org.apache.rat.config.SourceCodeManagementSystems

If there is a external way to configure files to be ignored: name of this file, null otherwise.

IHeaderMatcher - Interface in org.apache.rat.analysis

Matches text headers to known licenses.

ILicenseFamily - Interface in org.apache.rat.license

IMAGE_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

in - Variable in class org.apache.rat.ReportTransformer

includes - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies files, which are included in the report.

includesFile - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies a file, from which to read includes.

includesFileCharset - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies the include files character set.

incMapValue(Map<String, Integer>, String) - Method in class org.apache.rat.report.claim.impl.ClaimAggregator

indentSize - Variable in class org.apache.rat.mp.HelpMojo

The number of spaces per indentation level, should be positive.

inElement - Variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

init() - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense

inputFileFilter - Variable in class org.apache.rat.Report

inputStream() - Method in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

inputStream() - Method in interface org.apache.rat.api.Document

Streams the document's contents.

inputStream() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument

inputStream() - Method in class org.apache.rat.document.impl.FileDocument

inputStream() - Method in class org.apache.rat.document.impl.MonolithicFileDocument

inputStream() - Method in class org.apache.rat.mp.FilesReportable.FileDocument

InvalidXmlException - Exception in org.apache.rat.report.xml.writer

Indicates that the requested document would not be well formed.

InvalidXmlException(String) - Constructor for exception org.apache.rat.report.xml.writer.InvalidXmlException

IReportable - Interface in org.apache.rat.report

is(String) - Method in enum org.apache.rat.config.ReportFormat

isAddingLicenses() - Method in class org.apache.rat.ReportConfiguration

isAddingLicensesForced() - Method in class org.apache.rat.ReportConfiguration

isApproveDefaultLicenses() - Method in class org.apache.rat.ReportConfiguration

isArchive(Document) - Static method in class org.apache.rat.document.impl.guesser.ArchiveGuesser

isArchive(String) - Static method in class org.apache.rat.document.impl.guesser.ArchiveGuesser

isAudio(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinary(CharSequence) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinary(Reader) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinary(InputStream) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinary(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinary(Document) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinaryData(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBinaryDocument(Document) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isBytecode(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isComment(String) - Static method in class org.apache.rat.mp.util.ScmIgnoreParser

Determines whether the given line is a comment or not based on scanning for prefixes COMMENT_PREFIXES.

isComposite() - Method in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

isComposite() - Method in interface org.apache.rat.api.Document

Is this a composite document?

isComposite() - Method in class org.apache.rat.document.impl.AbstractMonolithicDocument

isComposite() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument

isComposite() - Method in class org.apache.rat.document.impl.FileDocument

isComposite() - Method in class org.apache.rat.mp.FilesReportable.FileDocument

isCopyrightMatch() - Method in class org.apache.rat.analysis.license.CopyrightHeader

isExecutable(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isExternalReport() - Method in class org.apache.rat.mp.RatReportMojo

Returns, whether this is an external report.

isFamilyAPT(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isFamilyBAT(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isFamilyC(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isFamilySGML(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isFamilySH(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isFamilyVelocity(int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isFilteredOut(char) - Method in class org.apache.rat.header.ArrayCharFilter

isFilteredOut(char) - Method in interface org.apache.rat.header.CharFilter

Is the given character filtered out?

isFinished() - Method in class org.apache.rat.analysis.HeaderCheckWorker

isForced - Variable in class org.apache.rat.annotation.AbstractLicenseAppender

isImage(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isIn(int[], int) - Static method in class org.apache.rat.annotation.AbstractLicenseAppender

isInvalidName(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

isKeystore(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isMatch() - Method in class org.apache.rat.header.HeaderBean

isNonBinary(String) - Static method in class org.apache.rat.document.impl.guesser.BinaryGuesser

isNote(String) - Static method in class org.apache.rat.document.impl.guesser.NoteGuesser

isNote(Document) - Static method in class org.apache.rat.document.impl.guesser.NoteGuesser

isNotEmpty(String) - Static method in class org.apache.rat.mp.HelpMojo

isNotIgnored(File) - Method in class org.apache.rat.walker.Walker

isOutOfRange(char) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

isRestricted() - Method in class org.apache.rat.walker.DirectoryWalker

isRestricted(File) - Method in class org.apache.rat.walker.Walker

isValidNameBody(char) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

isValidNameStart(char) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

isZip(File) - Static method in class org.apache.rat.document.impl.DocumentImplUtils

isZipStream(InputStream) - Static method in class org.apache.rat.document.impl.DocumentImplUtils

IXmlWriter - Interface in org.apache.rat.report.xml.writer

Simple interface for creating basic xml documents.

J

JAR_MANIFEST - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

JAVA - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

JAVADOC_REGEX_DEFN - Static variable in class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

JavaDocLicenseNotRequired - Class in org.apache.rat.analysis.generation

JavaDocs are generated and so no license is required.

JavaDocLicenseNotRequired() - Constructor for class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

K

KEYSTORE_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

L

length - Variable in class org.apache.rat.header.ArrayCharFilter

LICENSE_APPROVAL_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

LICENSE_FAMILY_PREDICATE - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

LICENSE_REFERENCE_LINE - Static variable in class org.apache.rat.analysis.license.ApacheSoftwareLicense20

LICENSE_URL - Static variable in class org.apache.rat.analysis.license.DojoLicenseHeader

LicenseAddingReport - Class in org.apache.rat.report.claim.util

LicenseAddingReport(String, boolean) - Constructor for class org.apache.rat.report.claim.util.LicenseAddingReport

licenseFamilies - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies the license families to accept.

LicenseFamily - Class in org.apache.rat.api.domain

Licenses are grouped into families.

LicenseFamily(String, String, String) - Constructor for class org.apache.rat.api.domain.LicenseFamily

Constructs an immutable license family.

licenseFamily - Variable in enum org.apache.rat.api.domain.RatLicenseFamily

Constructed from other data

licenseFamily() - Method in enum org.apache.rat.api.domain.RatLicenseFamily

Gets a LicenseFamily representing this data.

LicenseFamilyBuilder - Class in org.apache.rat.api.domain

Builds LicenseFamily instances.

LicenseFamilyBuilder() - Constructor for class org.apache.rat.api.domain.LicenseFamilyBuilder

Use {@link #aLicenseFamily()

licenseFamilyCategory - Variable in class org.apache.rat.analysis.license.BaseLicense

licenseFamilyCodeMap - Variable in class org.apache.rat.report.claim.ClaimStatistic

licenseFamilyName - Variable in class org.apache.rat.analysis.license.BaseLicense

licenseFamilyNameMap - Variable in class org.apache.rat.report.claim.ClaimStatistic

licenseFamilyNames - Variable in class org.apache.rat.mp.AbstractRatMojo

Deprecated.

Use AbstractRatMojo.licenseFamilies instead.

LicenseFamilySpecification - Class in org.apache.rat.mp

Used to specify additional license families.

LicenseFamilySpecification() - Constructor for class org.apache.rat.mp.LicenseFamilySpecification

licenseMatchers - Variable in class org.apache.rat.anttasks.Report

The licenses we want to match on.

licenseMatchers - Variable in class org.apache.rat.mp.AbstractRatMojo

Deprecated.

Use AbstractRatMojo.licenses instead.

licenseNames - Variable in class org.apache.rat.anttasks.Report

licenses - Variable in class org.apache.rat.mp.AbstractRatMojo

Specifies the licenses to accept.

LINE_SEP - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

the line separator for this OS

lineLength - Variable in class org.apache.rat.mp.HelpMojo

The maximum length of a display line, should be positive.

linePatterns - Variable in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

lines - Variable in class org.apache.rat.header.HeaderMatcher

lines() - Method in class org.apache.rat.header.HeaderMatcher

Number of lines read.

localRepository - Variable in class org.apache.rat.mp.RatReportMojo

logAboutIncludedFiles(String[]) - Method in class org.apache.rat.mp.AbstractRatMojo

logLicenseMatchers(List<IHeaderMatcher>) - Method in class org.apache.rat.mp.AbstractRatMojo

M

main(String[]) - Static method in class org.apache.rat.Report

mark(int) - Method in class org.apache.rat.annotation.BOMInputStream

markedAtStart - Variable in class org.apache.rat.annotation.BOMInputStream

markFbIndex - Variable in class org.apache.rat.annotation.BOMInputStream

match(Document, String) - Method in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

match(Document, String) - Method in class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

match - Variable in class org.apache.rat.analysis.HeaderCheckWorker

match(Document, String) - Method in interface org.apache.rat.analysis.IHeaderMatcher

Matches the text accumulated to licenses.

match(Document, String) - Method in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20

match(Document, String) - Method in class org.apache.rat.analysis.license.CDDL1License

match(Document, String) - Method in class org.apache.rat.analysis.license.CopyrightHeader

match(Document, String) - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense

match(Document, String) - Method in class org.apache.rat.analysis.license.OASISLicense

match(Document, String) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense

match(Document, String) - Method in class org.apache.rat.analysis.util.HeaderMatcherMultiplexer

match(Document, String) - Method in class org.apache.rat.anttasks.FullTextLicenseMatcher

match - Variable in class org.apache.rat.header.HeaderBean

matchCopyright(String) - Method in class org.apache.rat.analysis.license.CopyrightHeader

matcher - Variable in class org.apache.rat.analysis.DefaultAnalyserFactory.DefaultAnalyser

matcher - Variable in class org.apache.rat.analysis.DocumentHeaderAnalyser

matcher - Variable in class org.apache.rat.analysis.HeaderCheckWorker

matchers - Variable in class org.apache.rat.analysis.util.HeaderMatcherMultiplexer

matches(String) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense

matches(int[]) - Method in class org.apache.rat.annotation.BOMInputStream

matches(Pattern) - Method in class org.apache.rat.header.HeaderMatcher

Seeks a match in the last headers read.

MAVEN_DEFAULT_EXCLUDES - Static variable in class org.apache.rat.mp.util.ExclusionHelper

The Maven specific default excludes.

mediaType - Variable in class org.apache.rat.api.ContentType

mergeApprovedLicenseNames() - Method in class org.apache.rat.mp.AbstractRatMojo

mergeDefaultExclusions() - Method in class org.apache.rat.mp.AbstractRatMojo

mergeLicenseMatchers() - Method in class org.apache.rat.mp.AbstractRatMojo

Returns the set of header matchers to use.

MESSAGE - Static variable in exception org.apache.rat.analysis.RatReportAnalysisResultException

metaData - Variable in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

MetaData - Class in org.apache.rat.api

Data about the subject.

MetaData() - Constructor for class org.apache.rat.api.MetaData

MetaData(ContentType) - Constructor for class org.apache.rat.api.MetaData

metaData - Variable in class org.apache.rat.document.impl.AbstractMonolithicDocument

metaData - Variable in class org.apache.rat.document.impl.ArchiveEntryDocument

metaData - Variable in class org.apache.rat.document.impl.FileDocument

metaData - Variable in class org.apache.rat.mp.FilesReportable.FileDocument

MetaData.Datum - Class in org.apache.rat.api

A datum.

MIDDLE_LICENSE_LINE - Static variable in class org.apache.rat.analysis.license.MITLicense

MimeTyper - Interface in org.apache.rat.api

Discovers the mime type of content.

MITLicense - Class in org.apache.rat.analysis.license

Base MIT license (all 3 parts).

MITLicense() - Constructor for class org.apache.rat.analysis.license.MITLicense

MITLicenseFamily - Class in org.apache.rat.license

Base implementation for MIT licenses.

MITLicenseFamily() - Constructor for class org.apache.rat.license.MITLicenseFamily

ModifiedBSDLicenseFamily - Class in org.apache.rat.license

ModifiedBSDLicenseFamily() - Constructor for class org.apache.rat.license.ModifiedBSDLicenseFamily

MonolithicFileDocument - Class in org.apache.rat.document.impl

MonolithicFileDocument(File) - Constructor for class org.apache.rat.document.impl.MonolithicFileDocument

N

name - Variable in class org.apache.rat.api.domain.LicenseFamily

Uniquely identifies this family.

name - Variable in class org.apache.rat.api.domain.LicenseFamilyBuilder

Uniquely identifies this family.

name - Variable in enum org.apache.rat.api.domain.RatLicenseFamily

name - Variable in class org.apache.rat.api.MetaData.Datum

name - Variable in class org.apache.rat.document.impl.AbstractMonolithicDocument

name - Variable in class org.apache.rat.document.impl.ArchiveEntryDocument

name - Variable in class org.apache.rat.document.impl.FileDocument

NAME - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

name - Variable in class org.apache.rat.walker.Walker

NAME_BODY_CHAR - Static variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

NAME_MASK - Static variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

NAME_START_MASK - Static variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

NAME_START_OR_BODY_CHAR - Static variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

nestedResources - Variable in class org.apache.rat.anttasks.Report

will hold any nested resource collection

newInstance(URL) - Static method in class org.apache.rat.document.impl.MonolithicFileDocument

newInstance(Class<T>, String) - Static method in class org.apache.rat.mp.util.ConfigurationHelper

NON_ASCII_THRESHOLD - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

NON_BINARY_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

Based on https://www.apache.org/dev/svn-eol-style.txt

normalise(String) - Static method in class org.apache.rat.document.impl.guesser.GuessUtils

Converts name to upper case and strips any path.

NOTE_FILE_EXTENSIONS - Static variable in class org.apache.rat.document.impl.guesser.NoteGuesser

NOTE_FILE_NAMES - Static variable in class org.apache.rat.document.impl.guesser.NoteGuesser

NoteGuesser - Class in org.apache.rat.document.impl.guesser

NoteGuesser() - Constructor for class org.apache.rat.document.impl.guesser.NoteGuesser

notes - Variable in class org.apache.rat.analysis.license.BaseLicense

NOTES - Static variable in class org.apache.rat.analysis.license.W3CDocLicense

NOTES - Static variable in class org.apache.rat.analysis.license.W3CLicense

notes - Variable in class org.apache.rat.api.domain.LicenseFamily

Further information associated with the license family.

notes - Variable in class org.apache.rat.api.domain.LicenseFamilyBuilder

Further information associated with the license family.

notes - Variable in enum org.apache.rat.api.domain.RatLicenseFamily

numApproved - Variable in class org.apache.rat.report.claim.ClaimStatistic

numApproved - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

numberOfRetainedHeaderLines - Variable in class org.apache.rat.analysis.HeaderCheckWorker

numGenerated - Variable in class org.apache.rat.report.claim.ClaimStatistic

numGenerated - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

numsByFileType - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

numsByLicenseFamilyCode - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

numsByLicenseFamilyName - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

numUnApproved - Variable in class org.apache.rat.report.claim.ClaimStatistic

numUnApproved - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

numUnapprovedLicenses - Variable in class org.apache.rat.mp.RatCheckMojo

Maximum number of files with unapproved licenses.

numUnknown - Variable in class org.apache.rat.report.claim.ClaimStatistic

numUnknown - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

O

OASISLicense - Class in org.apache.rat.analysis.license

Looks for documents contain the OASIS copyright claim plus derivative work clause.

OASISLicense() - Constructor for class org.apache.rat.analysis.license.OASISLicense

OASISLicenseFamily - Class in org.apache.rat.license

OASISLicenseFamily() - Constructor for class org.apache.rat.license.OASISLicenseFamily

openElement(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

Writes the start of an element.

openElement(CharSequence) - Method in interface org.apache.rat.report.xml.writer.IXmlWriter

Writes the start of an element.

OperationNotAllowedException - Exception in org.apache.rat.report.xml.writer

Thrown by IXmlWriter implementations when the current state does not allow the requested operation.

OperationNotAllowedException(String) - Constructor for exception org.apache.rat.report.xml.writer.OperationNotAllowedException

org.apache.rat - package org.apache.rat

org.apache.rat.analysis - package org.apache.rat.analysis

org.apache.rat.analysis.generation - package org.apache.rat.analysis.generation

org.apache.rat.analysis.license - package org.apache.rat.analysis.license

org.apache.rat.analysis.util - package org.apache.rat.analysis.util

org.apache.rat.annotation - package org.apache.rat.annotation

org.apache.rat.anttasks - package org.apache.rat.anttasks

org.apache.rat.api - package org.apache.rat.api

Key abstractions.

org.apache.rat.api.domain - package org.apache.rat.api.domain

org.apache.rat.config - package org.apache.rat.config

Contains source code management / revision control information used during plugin runs.

org.apache.rat.document - package org.apache.rat.document

org.apache.rat.document.impl - package org.apache.rat.document.impl

org.apache.rat.document.impl.guesser - package org.apache.rat.document.impl.guesser

org.apache.rat.document.impl.util - package org.apache.rat.document.impl.util

org.apache.rat.header - package org.apache.rat.header

org.apache.rat.license - package org.apache.rat.license

org.apache.rat.mp - package org.apache.rat.mp

This package contains the Rat plugins for Maven.

org.apache.rat.mp.util - package org.apache.rat.mp.util

org.apache.rat.policy - package org.apache.rat.policy

org.apache.rat.report - package org.apache.rat.report

org.apache.rat.report.claim - package org.apache.rat.report.claim

org.apache.rat.report.claim.impl - package org.apache.rat.report.claim.impl

org.apache.rat.report.claim.impl.xml - package org.apache.rat.report.claim.impl.xml

org.apache.rat.report.claim.util - package org.apache.rat.report.claim.util

org.apache.rat.report.xml - package org.apache.rat.report.xml

org.apache.rat.report.xml.writer - package org.apache.rat.report.xml.writer

org.apache.rat.report.xml.writer.impl.base - package org.apache.rat.report.xml.writer.impl.base

org.apache.rat.walker - package org.apache.rat.walker

out - Variable in class org.apache.rat.ReportTransformer

outputDirectory - Variable in class org.apache.rat.mp.RatReportMojo

Specifies the directory where the report will be generated

P

parameters - Variable in class org.apache.rat.api.ContentType

parseExclusions(List<String>) - Static method in class org.apache.rat.Report

parseSCMIgnoresAsExcludes - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to parse source code management system (SCM) ignore files and use their contents as excludes.

passThroughReadNext(Writer, String, BufferedReader) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Pattern() - Constructor for class org.apache.rat.anttasks.SubstringLicenseMatcher.Pattern

patterns - Variable in class org.apache.rat.analysis.license.SimplePatternBasedLicense

patterns - Variable in class org.apache.rat.anttasks.SubstringLicenseMatcher

phrases - Variable in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

PLAIN - Static variable in class org.apache.rat.anttasks.Report.Format

PLAIN_KEY - Static variable in class org.apache.rat.anttasks.Report.Format

PLAIN_STYLESHEET - Static variable in class org.apache.rat.Defaults

PLUGIN_HELP_PATH - Static variable in class org.apache.rat.mp.HelpMojo

printUsage(Options) - Static method in class org.apache.rat.Report

process(RatReport, File) - Method in class org.apache.rat.walker.DirectoryWalker

Process a directory, ignoring any files/directories set to be ignored.

processDirectories(RatReport, File[]) - Method in class org.apache.rat.walker.DirectoryWalker

Process all directories in a set of file objects, ignoring any directories set to be ignored.

processDirectory(RatReport, File) - Method in class org.apache.rat.walker.DirectoryWalker

Process a directory, restricted directories will be ignored.

processNonDirectories(RatReport, File[]) - Method in class org.apache.rat.walker.DirectoryWalker

Process all files in a set of file objects, ignoring any files set to be ignored.

project - Variable in class org.apache.rat.anttasks.FullTextLicenseMatcher

project - Variable in class org.apache.rat.mp.AbstractRatMojo

Holds the maven-internal project to allow resolution of artifact properties during mojo runs.

prologWritten - Variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

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

R

RAT_APPROVED_LICENSE_DATIM_FALSE - Static variable in class org.apache.rat.api.MetaData

RAT_APPROVED_LICENSE_DATIM_TRUE - Static variable in class org.apache.rat.api.MetaData

RAT_APPROVED_LICENSE_VALUE_FALSE - Static variable in class org.apache.rat.api.MetaData

RAT_APPROVED_LICENSE_VALUE_TRUE - Static variable in class org.apache.rat.api.MetaData

RAT_BASE_URL - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_DATUM_ARCHIVE - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_DATUM_BINARY - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_DATUM_GENERATED - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_DATUM_NOTICE - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_DATUM_STANDARD - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_DATUM_UNKNOWN - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_VALUE_ARCHIVE - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_VALUE_BINARY - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_VALUE_GENERATED - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_VALUE_NOTICE - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_VALUE_STANDARD - Static variable in class org.apache.rat.api.MetaData

RAT_DOCUMENT_CATEGORY_VALUE_UNKNOWN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_ASL - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_CDLL1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_GEN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL2 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_GPL3 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_MIT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_OASIS - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_TMF - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_UNKNOWN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3CD - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_ASL - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_CDDL1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL2 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_GPL3 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_MIT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_OASIS - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_TMF - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_ACADEMIC_FREE_LICENSE_VERSION_2_1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_APACHE_LICENSE_VERSION_2_0 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_CDDL1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_2 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_GPL_VERSION_3 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_MIT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_MODIFIED_BSD_LICENSE - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_OASIS_OPEN_LICENSE - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_UNKNOWN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_ACADEMIC_FREE_LICENSE_VERSION_2_1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_CDDL1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_1 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_2 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_GPL_VERSION_3 - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_MIT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData

RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT - Static variable in class org.apache.rat.api.MetaData

RAT_REPORT - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

RAT_URL_APPROVED_LICENSE - Static variable in class org.apache.rat.api.MetaData

RAT_URL_DOCUMENT_CATEGORY - Static variable in class org.apache.rat.api.MetaData

RAT_URL_HEADER_CATEGORY - Static variable in class org.apache.rat.api.MetaData

RAT_URL_HEADER_SAMPLE - Static variable in class org.apache.rat.api.MetaData

RAT_URL_LICENSE_FAMILY_CATEGORY - Static variable in class org.apache.rat.api.MetaData

RAT_URL_LICENSE_FAMILY_NAME - Static variable in class org.apache.rat.api.MetaData

RatCheckException - Exception in org.apache.rat.mp

RatCheckException(String) - Constructor for exception org.apache.rat.mp.RatCheckException

RatCheckMojo - Class in org.apache.rat.mp

Run Rat to perform a violation check.

RatCheckMojo() - Constructor for class org.apache.rat.mp.RatCheckMojo

RatDocumentAnalysisException - Exception in org.apache.rat.document

RatDocumentAnalysisException() - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException

RatDocumentAnalysisException(String) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException

RatDocumentAnalysisException(Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException

RatDocumentAnalysisException(String, Throwable) - Constructor for exception org.apache.rat.document.RatDocumentAnalysisException

RatException - Exception in org.apache.rat.api

RatException() - Constructor for exception org.apache.rat.api.RatException

RatException(String, Throwable) - Constructor for exception org.apache.rat.api.RatException

RatException(String) - Constructor for exception org.apache.rat.api.RatException

RatException(Throwable) - Constructor for exception org.apache.rat.api.RatException

RatHeaderAnalysisException - Exception in org.apache.rat.analysis

Indicates exceptional condition during header analysis.

RatHeaderAnalysisException() - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException

RatHeaderAnalysisException(String, Throwable) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException

RatHeaderAnalysisException(String) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException

RatHeaderAnalysisException(Throwable) - Constructor for exception org.apache.rat.analysis.RatHeaderAnalysisException

RatLicenseFamily - Enum in org.apache.rat.api.domain

Enumerates standard license families known to Rat.

RatLicenseFamily(String, String, String) - Constructor for enum org.apache.rat.api.domain.RatLicenseFamily

Constructs an instance.

RatReport - Interface in org.apache.rat.report

RatReportAnalysisResultException - Exception in org.apache.rat.analysis

RatReportAnalysisResultException() - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException

RatReportAnalysisResultException(RatException) - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException

RatReportAnalysisResultException(String, RatException) - Constructor for exception org.apache.rat.analysis.RatReportAnalysisResultException

RatReportMojo - Class in org.apache.rat.mp

Generates a report with Rat's output.

RatReportMojo() - Constructor for class org.apache.rat.mp.RatReportMojo

rawWrite(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

rc - Variable in class org.apache.rat.anttasks.ResourceCollectionContainer

read() - Method in class org.apache.rat.analysis.HeaderCheckWorker

read() - Method in class org.apache.rat.annotation.BOMInputStream

read(byte[], int, int) - Method in class org.apache.rat.annotation.BOMInputStream

read(byte[]) - Method in class org.apache.rat.annotation.BOMInputStream

read - Variable in class org.apache.rat.header.HeaderMatcher

read(Reader) - Method in class org.apache.rat.header.HeaderMatcher

reader - Variable in class org.apache.rat.analysis.HeaderCheckWorker

reader() - Method in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

reader() - Method in interface org.apache.rat.api.Document

Reads the content of this document.

reader() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument

reader() - Method in class org.apache.rat.document.impl.FileDocument

reader() - Method in class org.apache.rat.document.impl.MonolithicFileDocument

reader() - Method in class org.apache.rat.mp.FilesReportable.FileDocument

readFirstBytes() - Method in class org.apache.rat.annotation.BOMInputStream

readLine(StringBuilder) - Method in class org.apache.rat.analysis.HeaderCheckWorker

regexFilter(Pattern) - Static method in class org.apache.rat.walker.Walker

repeat(String, int) - Static method in class org.apache.rat.mp.HelpMojo

Repeat a String n times to form a new string.

Report - Class in org.apache.rat.anttasks

A basic Ant task that generates a report on all files specified by the nested resource collection(s).

Report() - Constructor for class org.apache.rat.anttasks.Report

Report - Class in org.apache.rat

Report(String) - Constructor for class org.apache.rat.Report

report(Document) - Method in class org.apache.rat.report.AbstractReport

report(Document) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

report(Document) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

report(Document) - Method in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

report(Document) - Method in class org.apache.rat.report.claim.util.LicenseAddingReport

report(Document) - Method in interface org.apache.rat.report.RatReport

report(PrintStream) - Method in class org.apache.rat.Report

Deprecated.

use Report.report(PrintStream, ReportConfiguration) instead

report(PrintStream, ReportConfiguration) - Method in class org.apache.rat.Report

report(PrintStream, IReportable, InputStream, ReportConfiguration) - Static method in class org.apache.rat.Report

Output a report that is styled using a defined stylesheet.

report(Writer, IReportable, InputStream, ReportConfiguration) - Static method in class org.apache.rat.Report

Output a report that is styled using a defined stylesheet.

report(IReportable, Writer, ReportConfiguration) - Static method in class org.apache.rat.Report

report(RatReport, byte[], File) - Method in class org.apache.rat.walker.ArchiveWalker

Report on the given file.

report(RatReport, File) - Method in class org.apache.rat.walker.DirectoryWalker

Report on the given file.

Report.AddLicenseHeaders - Class in org.apache.rat.anttasks

Type for the addLicenseHeaders attribute.

Report.Format - Class in org.apache.rat.anttasks

Type for the format attribute.

ReportConfiguration - Class in org.apache.rat

A configuration object is used by the frontend to invoke the Report.

ReportConfiguration() - Constructor for class org.apache.rat.ReportConfiguration

reporters - Variable in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

ReportFailedRuntimeException - Exception in org.apache.rat

Indicates that a report has failed in a fatal manner.

ReportFailedRuntimeException() - Constructor for exception org.apache.rat.ReportFailedRuntimeException

ReportFailedRuntimeException(String, Throwable) - Constructor for exception org.apache.rat.ReportFailedRuntimeException

ReportFailedRuntimeException(String) - Constructor for exception org.apache.rat.ReportFailedRuntimeException

ReportFailedRuntimeException(Throwable) - Constructor for exception org.apache.rat.ReportFailedRuntimeException

reportFile - Variable in class org.apache.rat.anttasks.Report

Where to send the report.

reportFile - Variable in class org.apache.rat.mp.RatCheckMojo

Where to store the report.

ReportFormat - Enum in org.apache.rat.config

ReportFormat() - Constructor for enum org.apache.rat.config.ReportFormat

reportLicenseApprovalClaim(Document, boolean) - Method in class org.apache.rat.policy.DefaultPolicy

reportOnLicense(Document) - Method in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

reportOnLicense(Document) - Method in class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

reportOnLicense(Document) - Method in class org.apache.rat.analysis.license.BaseLicense

reportStyle - Variable in class org.apache.rat.mp.RatCheckMojo

Output style of the report.

ReportTransformer - Class in org.apache.rat

ReportTransformer(Writer, Reader, Reader) - Constructor for class org.apache.rat.ReportTransformer

ReportTransformer(Writer, InputStream, Reader) - Constructor for class org.apache.rat.ReportTransformer

reset() - Method in class org.apache.rat.analysis.generation.GeneratedLicenseNotRequired

reset() - Method in class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

reset() - Method in interface org.apache.rat.analysis.IHeaderMatcher

Resets this matches.

reset() - Method in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20

reset() - Method in class org.apache.rat.analysis.license.CDDL1License

reset() - Method in class org.apache.rat.analysis.license.CopyrightHeader

reset() - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense

reset() - Method in class org.apache.rat.analysis.license.OASISLicense

reset() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense

reset() - Method in class org.apache.rat.analysis.util.HeaderMatcherMultiplexer

reset() - Method in class org.apache.rat.annotation.BOMInputStream

resolver - Variable in class org.apache.rat.mp.RatReportMojo

resource - Variable in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

ResourceCollectionContainer - Class in org.apache.rat.anttasks

Implementation of IReportable that traverses over a resource collection internally.

ResourceCollectionContainer(ResourceCollection) - Constructor for class org.apache.rat.anttasks.ResourceCollectionContainer

ResourceCollectionContainer.ResourceDocument - Class in org.apache.rat.anttasks

ResourceDocument() - Constructor for class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

run(RatReport) - Method in class org.apache.rat.anttasks.ResourceCollectionContainer

run(RatReport) - Method in class org.apache.rat.mp.FilesReportable

run(RatReport) - Method in interface org.apache.rat.report.IReportable

run() - Method in class org.apache.rat.ReportTransformer

run(RatReport) - Method in class org.apache.rat.walker.ArchiveWalker

Run a report over all files and directories in this GZIPWalker, ignoring any files/directories set to be ignored.

run(RatReport) - Method in class org.apache.rat.walker.DirectoryWalker

Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.

S

ScmIgnoreParser - Class in org.apache.rat.mp.util

Helper to parse SCM ignore files to add entries as excludes during RAT runs.

ScmIgnoreParser() - Constructor for class org.apache.rat.mp.util.ScmIgnoreParser

seenFirstLine - Variable in class org.apache.rat.analysis.license.FullTextMatchingLicense

SEPARATOR - Static variable in enum org.apache.rat.config.AddLicenseHeaders

SEPARATORS - Static variable in class org.apache.rat.document.impl.guesser.GuessUtils

serialVersionUID - Static variable in exception org.apache.rat.analysis.RatHeaderAnalysisException

serialVersionUID - Static variable in exception org.apache.rat.analysis.RatReportAnalysisResultException

serialVersionUID - Static variable in exception org.apache.rat.api.RatException

serialVersionUID - Static variable in exception org.apache.rat.document.CompositeDocumentException

serialVersionUID - Static variable in exception org.apache.rat.document.RatDocumentAnalysisException

serialVersionUID - Static variable in exception org.apache.rat.document.UnsuitableDocumentException

serialVersionUID - Static variable in exception org.apache.rat.mp.RatCheckException

serialVersionUID - Static variable in exception org.apache.rat.report.xml.writer.InvalidXmlException

serialVersionUID - Static variable in exception org.apache.rat.report.xml.writer.OperationNotAllowedException

serialVersionUID - Static variable in exception org.apache.rat.ReportFailedRuntimeException

set(MetaData.Datum) - Method in class org.apache.rat.api.MetaData

Puts in a new datum replacing any existing data.

setAddDefaultLicenseMatchers(boolean) - Method in class org.apache.rat.anttasks.Report

setAddingLicenses(boolean) - Method in class org.apache.rat.ReportConfiguration

Returns, whether Rat should add missing license headers.

setAddingLicensesForced(boolean) - Method in class org.apache.rat.ReportConfiguration

If Rat is adding license headers: Sets, whether adding license headers is enforced.

setAddLicenseHeaders(Report.AddLicenseHeaders) - Method in class org.apache.rat.anttasks.Report

setApproveDefaultLicenses(boolean) - Method in class org.apache.rat.ReportConfiguration

setApprovedLicenseNames(ILicenseFamily[]) - Method in class org.apache.rat.ReportConfiguration

Sets the set of approved license names.

setApprovedLicenseNames(List<ILicenseFamily>) - Method in class org.apache.rat.ReportConfiguration

Sets the set of approved license names (convenience).

setClassName(String) - Method in class org.apache.rat.mp.HeaderMatcherSpecification

Sets the license matchers class name.

setClassName(String) - Method in class org.apache.rat.mp.LicenseFamilySpecification

Sets the license family's class name.

setContentType(ContentType) - Method in class org.apache.rat.api.MetaData

Sets the content type for this subject.

setCopyrightMessage(String) - Method in class org.apache.rat.anttasks.Report

setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration

If Rat is adding license headers: Sets the optional copyright message.

setCopyrightOwner(String) - Method in class org.apache.rat.analysis.license.CopyrightHeader

setDocumentCategoryMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets a map with the file types.

setExcludes(DirectoryScanner) - Method in class org.apache.rat.mp.AbstractRatMojo

setFamilyName(String) - Method in class org.apache.rat.license.SimpleLicenseFamily

setFile(File) - Method in class org.apache.rat.mp.FilesReportable.FileDocument

setForce(boolean) - Method in class org.apache.rat.annotation.AbstractLicenseAppender

Set the force flag on this appender.

setFormat(Report.Format) - Method in class org.apache.rat.anttasks.Report

Which format to use.

setFullText(String) - Method in class org.apache.rat.analysis.license.FullTextMatchingLicense

setHeaderMatcher(IHeaderMatcher) - Method in class org.apache.rat.ReportConfiguration

Sets the header matcher.

setHeaderPattern(Pattern) - Method in class org.apache.rat.header.HeaderBean

Sets the header pattern to be matched.

setIncludes(DirectoryScanner) - Method in class org.apache.rat.mp.AbstractRatMojo

setInputFileFilter(FilenameFilter) - Method in class org.apache.rat.Report

Sets the current filter used to select files.

setLicenseFamilyCategory(String) - Method in class org.apache.rat.analysis.license.BaseLicense

setLicenseFamilyName(String) - Method in class org.apache.rat.analysis.license.BaseLicense

setLicenseFileCodeMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets a map with the license family codes.

setLicenseFileNameMap(Map<String, Integer>) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets map with the license family codes.

setMatch(boolean) - Method in class org.apache.rat.header.HeaderBean

setNotes(String) - Method in class org.apache.rat.analysis.license.BaseLicense

setNumApproved(int) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets the number of files with approved licenses.

setNumGenerated(int) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets the number of generated files.

setNumUnApproved(int) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets the number of files with unapproved licenses.

setNumUnknown(int) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets the number of files, which are neither generated nor have a known license header.

setPatterns(String[]) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense

setProject(Project) - Method in class org.apache.rat.anttasks.FullTextLicenseMatcher

setReportFile(File) - Method in class org.apache.rat.anttasks.Report

Where to send the report to.

setReportOutputDirectory(File) - Method in class org.apache.rat.mp.RatReportMojo

Sets the reports output directory.

setResource(Resource) - Method in class org.apache.rat.anttasks.ResourceCollectionContainer.ResourceDocument

setSubstring(String) - Method in class org.apache.rat.anttasks.SubstringLicenseMatcher.Pattern

SimpleLicenseFamily - Class in org.apache.rat.license

Trivial bean implementing ILicenseFamily

SimpleLicenseFamily(String) - Constructor for class org.apache.rat.license.SimpleLicenseFamily

SimpleLicenseFamily() - Constructor for class org.apache.rat.license.SimpleLicenseFamily

SimplePatternBasedLicense - Class in org.apache.rat.analysis.license

SimplePatternBasedLicense() - Constructor for class org.apache.rat.analysis.license.SimplePatternBasedLicense

SimplePatternBasedLicense(MetaData.Datum, MetaData.Datum, String, String[]) - Constructor for class org.apache.rat.analysis.license.SimplePatternBasedLicense

SimpleXmlClaimReporter - Class in org.apache.rat.report.claim.impl.xml

SimpleXmlClaimReporter(IXmlWriter) - Constructor for class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

siteRenderer - Variable in class org.apache.rat.mp.RatReportMojo

skip(long) - Method in class org.apache.rat.annotation.BOMInputStream

skip - Variable in class org.apache.rat.mp.AbstractRatMojo

Will skip the plugin execution, e.g.

SourceCodeManagementSystems - Enum in org.apache.rat.config

SourceCodeManagementSystems(String, String) - Constructor for enum org.apache.rat.config.SourceCodeManagementSystems

startDocument() - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

Starts a document by writing a prolog.

startDocument() - Method in interface org.apache.rat.report.xml.writer.IXmlWriter

Starts a document by writing a prolog.

startReport() - Method in class org.apache.rat.report.AbstractReport

startReport() - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

startReport() - Method in class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

startReport() - Method in interface org.apache.rat.report.RatReport

statistic - Variable in class org.apache.rat.report.claim.impl.ClaimAggregator

STYLED_KEY - Static variable in class org.apache.rat.anttasks.Report.Format

styleReport(PrintStream) - Method in class org.apache.rat.Report

Deprecated.

use Report.styleReport(PrintStream, ReportConfiguration) instead

styleReport(PrintStream, ReportConfiguration) - Method in class org.apache.rat.Report

Output a report in the default style and default license header matcher.

stylesheet - Variable in class org.apache.rat.anttasks.Report

Which stylesheet to use.

STYLESHEET_CLI - Static variable in class org.apache.rat.Report

subject - Variable in class org.apache.rat.analysis.HeaderCheckWorker

substring - Variable in class org.apache.rat.anttasks.SubstringLicenseMatcher.Pattern

SubstringLicenseMatcher - Class in org.apache.rat.anttasks

Adapts SimplePatternBasedLicense to Ant's method naming conventions so it becomes easy to write substring based license matchers inside an Ant build file.

SubstringLicenseMatcher() - Constructor for class org.apache.rat.anttasks.SubstringLicenseMatcher

SubstringLicenseMatcher.Pattern - Class in org.apache.rat.anttasks

A simple wrapper around a substring.

subType - Variable in class org.apache.rat.api.ContentType

T

textMatcher - Variable in class org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20

textMatcherBase - Variable in class org.apache.rat.analysis.license.CDDL1License

textMatcherIllumosStyle - Variable in class org.apache.rat.analysis.license.CDDL1License

TIMESTAMP - Static variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

TMF854LicenseHeader - Class in org.apache.rat.analysis.license

TMF854LicenseHeader() - Constructor for class org.apache.rat.analysis.license.TMF854LicenseHeader

TO_NAME_TRANSFORMER - Static variable in class org.apache.rat.document.ToNameTransformer

toLines(String, int, int, int) - Static method in class org.apache.rat.mp.HelpMojo

Splits the specified text into lines of convenient display length.

toLines(List<String>, String, int, int) - Static method in class org.apache.rat.mp.HelpMojo

Adds the specified line to the output sequence, performing line wrapping if necessary.

toName(File) - Static method in class org.apache.rat.document.impl.DocumentImplUtils

toNames(ILicenseFamily[]) - Static method in class org.apache.rat.config.ConfigurationUtil

Extract license names from the given license families.

ToNameTransformer - Class in org.apache.rat.document

ToNameTransformer() - Constructor for class org.apache.rat.document.ToNameTransformer

toNameTransformer() - Static method in class org.apache.rat.document.ToNameTransformer

toString() - Method in class org.apache.rat.api.MetaData.Datum

Constructs a String with all attributes in name = value format.

toString() - Method in class org.apache.rat.document.impl.ArchiveEntryDocument

Representations suitable for logging.

toString() - Method in class org.apache.rat.document.impl.FileDocument

Representations suitable for logging.

toString() - Method in class org.apache.rat.mp.FilesReportable.FileDocument

TOTAL_READ_RATIO - Static variable in class org.apache.rat.document.impl.guesser.BinaryGuesser

transform(Object) - Method in class org.apache.rat.document.ToNameTransformer

transform() - Method in class org.apache.rat.ReportTransformer

transformer - Variable in class org.apache.rat.ReportTransformer

TRUE - Static variable in class org.apache.rat.anttasks.Report.AddLicenseHeaders

type(InputStream, String) - Method in interface org.apache.rat.api.MimeTyper

Guesses the mime type for the given content.

TYPE_APT - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_BAT - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_BEANSHELL - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_C - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_CPP - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_CSHARP - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_CSS - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_FML - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_GO - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_GROOVY - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_H - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_HTML - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_JAVA - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_JAVASCRIPT - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_JSP - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_PERL - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_PHP - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_PM - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_PROPERTIES - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_PYTHON - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_RUBY - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_SCALA - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_SH - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_TCL - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_UNKNOWN - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_VISUAL_STUDIO_SOLUTION - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_VM - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

TYPE_XML - Static variable in class org.apache.rat.annotation.AbstractLicenseAppender

U

UNAPPROVED_LICENSES_STYLESHEET - Static variable in class org.apache.rat.Defaults

UnsuitableDocumentException - Exception in org.apache.rat.document

Indicates that the document was unsuitable for analysis.

UnsuitableDocumentException() - Constructor for exception org.apache.rat.document.UnsuitableDocumentException

UnsuitableDocumentException(String, Throwable) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException

UnsuitableDocumentException(String) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException

UnsuitableDocumentException(Throwable) - Constructor for exception org.apache.rat.document.UnsuitableDocumentException

useDefaultExcludes - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to use the default excludes when scanning for files.

useEclipseDefaultExcludes - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to use the Eclipse specific default excludes when scanning for files.

useIdeaDefaultExcludes - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to use the IDEA specific default excludes when scanning for files.

useMavenDefaultExcludes - Variable in class org.apache.rat.mp.AbstractRatMojo

Whether to use the Maven specific default excludes when scanning for files.

UTF_8 - Static variable in class org.apache.rat.document.impl.MonolithicFileDocument

V

validate() - Method in class org.apache.rat.anttasks.FullTextLicenseMatcher

validate() - Method in class org.apache.rat.anttasks.Report

validates the task's configuration.

validate() - Method in class org.apache.rat.anttasks.SubstringLicenseMatcher

validated - Variable in class org.apache.rat.anttasks.FullTextLicenseMatcher

validated - Variable in class org.apache.rat.anttasks.SubstringLicenseMatcher

value - Variable in class org.apache.rat.api.MetaData.Datum

value(String) - Method in class org.apache.rat.api.MetaData

Gets the value of the first datum matching the given name.

valueOf(String) - Static method in enum org.apache.rat.api.domain.RatLicenseFamily

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.rat.config.AddLicenseHeaders

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.rat.config.ReportFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.rat.config.SourceCodeManagementSystems

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.rat.api.domain.RatLicenseFamily

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.rat.config.AddLicenseHeaders

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.rat.config.ReportFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.rat.config.SourceCodeManagementSystems

Returns an array containing the constants of this enum type, in the order they are declared.

W

W3CDocLicense - Class in org.apache.rat.analysis.license

W3CDocLicense() - Constructor for class org.apache.rat.analysis.license.W3CDocLicense

W3CDocumentLicenseFamily - Class in org.apache.rat.license

W3CDocumentLicenseFamily() - Constructor for class org.apache.rat.license.W3CDocumentLicenseFamily

W3CLicense - Class in org.apache.rat.analysis.license

W3CLicense() - Constructor for class org.apache.rat.analysis.license.W3CLicense

W3CSoftwareLicenseFamily - Class in org.apache.rat.license

W3CSoftwareLicenseFamily() - Constructor for class org.apache.rat.license.W3CSoftwareLicenseFamily

Walker - Class in org.apache.rat.walker

Abstract walker.

Walker(File, FilenameFilter) - Constructor for class org.apache.rat.walker.Walker

Walker(String, File, FilenameFilter) - Constructor for class org.apache.rat.walker.Walker

whenDebuggingLogExcludedFiles(DirectoryScanner) - Method in class org.apache.rat.mp.AbstractRatMojo

withCategory(String) - Method in class org.apache.rat.api.domain.LicenseFamilyBuilder

Builds family with category containing this license family.

withName(String) - Method in class org.apache.rat.api.domain.LicenseFamilyBuilder

Uniquely identifies this family.

withNotes(String) - Method in class org.apache.rat.api.domain.LicenseFamilyBuilder

Builds family with further information associated with the license family.

writeApprovedLicense(MetaData) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writeApprovedLicenseClaim(MetaData) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

writeAttribute(IXmlWriter, String, boolean) - Static method in class org.apache.rat.report.xml.writer.XmlWriterUtils

writeAttributeContent(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

writeBodyContent(CharSequence) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

writeClaim(String, String, boolean) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

Writes a single claim to the XML file.

writeDocumentCategory(MetaData) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

writeDocumentCategory(MetaData) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writeDocumentClaim(Document) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

writeDocumentClaims(Document) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writeEscaped(CharSequence, boolean) - Method in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

writeGoal(StringBuilder, String, Element) - Method in class org.apache.rat.mp.HelpMojo

writeHeaderCategory(MetaData) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

writeHeaderCategory(MetaData) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writeHeaderSample(MetaData) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writeLicenseFamilyName(MetaData) - Method in class org.apache.rat.report.claim.impl.AbstractClaimReporter

writeLicenseFamilyName(MetaData) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writeParameter(StringBuilder, Node, Node) - Method in class org.apache.rat.mp.HelpMojo

writer - Variable in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

writer - Variable in class org.apache.rat.report.xml.writer.impl.base.XmlWriter

X

XML_KEY - Static variable in class org.apache.rat.anttasks.Report.Format

XmlReportFactory - Class in org.apache.rat.report.xml

Creates reports.

XmlReportFactory() - Constructor for class org.apache.rat.report.xml.XmlReportFactory

XmlWriter - Class in org.apache.rat.report.xml.writer.impl.base

Lightweight IXmlWriter implementation.

XmlWriter(Writer) - Constructor for class org.apache.rat.report.xml.writer.impl.base.XmlWriter

XmlWriterUtils - Class in org.apache.rat.report.xml.writer

XmlWriterUtils() - Constructor for class org.apache.rat.report.xml.writer.XmlWriterUtils

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