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

AbstractLicenceAppender - Class in org.apache.rat.annotation

Add a licence header to a document.

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

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

Adds a license matcher.

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').

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

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

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 Software License, Version 2.0

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

ApacheV2LicenceAppender - Class in org.apache.rat.annotation

Add an Apache Software Licence V2 licence header to a document.

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

Create a licence appender with the standard ASF licence header.

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

Create a licence appender with the given copyright line.

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

Append the default licence header to the supplied document.

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.

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

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

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

Writes an attribute of an element.

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

Writes an attribute of an element.

B

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

The base directory, in which to search for files.

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

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.

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) - Constructor for class org.apache.rat.report.claim.util.ClaimReporterMultiplexer

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

This class provides a numerical overview about the report.

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

clear(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.

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

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

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

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

Writes content.

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

Writes content.

ContentType - Class in org.apache.rat.api

Describe the MIME content type of a resource.

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

Constructs content types, performing an necessary conversions.

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

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

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

D

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

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

The standard list of licenses to include in the reports.

DefaultAnalyserFactory - Class in org.apache.rat.analysis

Creates default analysers.

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

DefaultPolicy - Class in org.apache.rat.policy

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

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

DefaultPolicy(String[]) - 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.

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

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

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

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

E

ECLIPSE_DEFAULT_EXCLUDES - Static variable in class org.apache.rat.mp.AbstractRatMojo

The Eclipse specific default excludes.

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

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.RatCheckMojo

Invoked by Maven to execute the Mojo.

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

Called from Maven to invoke the plugin.

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

F

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

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

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

Document wrapping a file of undetermined composition.

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

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

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

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

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

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.ReportConfiguration

Returns the set of approved license names.

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

If RAT is adding license headers: Returns the optional copyright message.

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.

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

Returns a map with the file types.

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

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

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

Get the first line of the licence 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.

getInputFileFilter() - Method in class org.apache.rat.Report

Gets the current filter used to select files.

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

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

getLicenceHeader(File) - Method in class org.apache.rat.annotation.AbstractLicenceAppender

Get the licence header for a document.

getLicenceHeader(File) - Method in class org.apache.rat.annotation.ApacheV2LicenceAppender

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

Returns a map with the license family codes.

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

Returns a map with the license family codes.

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

Returns the set of header matchers to use.

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

Get a line of the licence 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 interface org.apache.rat.api.Document

Gets data describing this resource.

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

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

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

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

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

Gets the name of the data type.

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

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

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

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

Returns the reports name.

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

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

Returns the number of files with approved licenses.

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

Returns the number of generated files.

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

Returns the number of files with unapproved licenses.

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

Returns the number of files, which are neither generated nor have a known license header.

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

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

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

Returns the Maven project.

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.

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.AbstractLicenceAppender

Detect the type of document.

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

Data type value.

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

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

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

Licence matches GPL1 or later.

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

GPL1LicenseFamily - Class in org.apache.rat.license

Base implementation for GPLv3 or later.

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

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

Licence matches GPL2 or later.

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

GPL2LicenseFamily - Class in org.apache.rat.license

Base implementation for GPLv3 or later.

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

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

Licence 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

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

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

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

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

Delegates to an ordered set of matchers.

HeaderMatcherMultiplexer(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

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.AbstractRatMojo

The IDEA specific default excludes.

IDocumentAnalyser - Interface in org.apache.rat.document

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

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

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

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

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

Returns, whether RAT should add missing license headers.

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

If RAT is adding license headers: Returns, whether adding license headers is enforced.

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

Is a file by that name an archive?

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

Do the first few bytes of the stream hint at a binary file?

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

Do the first few bytes of the stream hint at a binary file?

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

Is a file by that name a known binary file?

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

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

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

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

Is this a composite document?

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

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

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

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.

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

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

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

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

Is a file by that name a known non-binary file?

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

Is a file by that name a note file?

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

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

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

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

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

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

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

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

LicenseFamilySpecification - Class in org.apache.rat.mp

Used to specify additional license familys.

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

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

Number of lines read.

M

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

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(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.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

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

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.AbstractRatMojo

The Maven specific default excludes.

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.Datum - Class in org.apache.rat.api

A datum.

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

Constructs 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.walker.Walker

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

Creates a new instance.

NON_ASCII_THREASHOLD - 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 http://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

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.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 2.

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

P

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

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

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_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_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_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_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_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

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

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

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

regexFilter(Pattern) - Static method in class org.apache.rat.walker.Walker

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(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 the two-arg version 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.AddLicenseHeaders - Class in org.apache.rat.anttasks

Type for the addLicenseHeaders attribute.

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

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

Report.Format - Class in org.apache.rat.anttasks

Type for the format attribute.

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

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

reportLicenseApprovalClaim(Document, boolean) - Method in class org.apache.rat.policy.DefaultPolicy

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

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.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

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

run(RatReport) - Method in class org.apache.rat.walker.ArchiveWalker

Run a report over all files and directories in this GZIPWalker, ignoring any files/directories set to be ignored.

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

Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.

S

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

Whether to add the default list of license matchers.

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

Whether to add license headers.

setApprovedLicenseNames(ILicenseFamily[]) - Method in class org.apache.rat.ReportConfiguration

Sets the set of approved license names.

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 familys 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

Sets the copyright message.

setCopyrightMessage(String) - Method in class org.apache.rat.ReportConfiguration

If RAT is adding license headers: Sets the optional copyright message.

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

Sets a map with the file types.

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

setForce(boolean) - Method in class org.apache.rat.annotation.AbstractLicenceAppender

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.

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) - Method in class org.apache.rat.report.claim.ClaimStatistic

Sets a map with the license family codes.

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

Returns a 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

Returns the number of generated files.

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

Returns 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.

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

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

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

Deprecated. use the two-arg version instead

styleReport(PrintStream, ReportConfiguration) - Method in class org.apache.rat.Report

Output a report in the default style and default licence header matcher.

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.

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

T

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

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

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

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.

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

transform(Object) - Method in class org.apache.rat.document.ToNameTransformer

type(InputStream, String) - Method in interface org.apache.rat.api.MimeTyper

Guesses the mime type for the given content.

U

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

V

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

Gets the value of the first datum matching the given name.

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

writeAttribute(IXmlWriter, String, boolean) - Static method in class org.apache.rat.report.xml.writer.XmlWriterUtils

writeClaim(String, String, boolean) - Method in class org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter

Writes a single claim to the XML file.

X

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