- canGenerateReport() - Method in class org.apache.rat.mp.RatReportMojo
-
Returns, whether the report may be generated.
- 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
-
- 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
-
- 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
-
- ConfigurationHelper - Class in org.apache.rat.mp.util
-
- ConfigurationUtil - Class in org.apache.rat.config
-
- ConfigurationUtil() - Constructor for class org.apache.rat.config.ConfigurationUtil
-
- 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<String, String>) - Constructor for class org.apache.rat.api.ContentType
-
Constructs content types,
performing an necessary conversions.
- COPYRIGHT_PREFIX_PATTERN_DEFN - Static variable in class org.apache.rat.analysis.license.CopyrightHeader
-
- 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
-
- createDefaultAnalyser(IHeaderMatcher) - Static method in class org.apache.rat.analysis.DefaultAnalyserFactory
-
- createDefaultMatcher() - Static method in class org.apache.rat.Defaults
-
- 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
-
- 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.policy.DefaultPolicy
-
- getApprovedLicenseNames() - Method in class org.apache.rat.ReportConfiguration
-
Returns the set of approved license names.
- 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.
- 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
-
- 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
- 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.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
-
- 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 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.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(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
-
- getPlainStyleSheet() - Static method in class org.apache.rat.Defaults
-
- getPluginExclusions() - Static method in enum org.apache.rat.config.SourceCodeManagementSystems
-
- getProject() - Method in class org.apache.rat.mp.AbstractRatMojo
-
- 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.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.
- 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
-
- 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
-
- ScmIgnoreParser - Class in org.apache.rat.mp.util
-
Helper to parse SCM ignore files to add entries as excludes during RAT runs.
- 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.
- setFamilyName(String) - Method in class org.apache.rat.license.SimpleLicenseFamily
-
- 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.
- 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.
- 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
-
- skip - Variable in class org.apache.rat.mp.AbstractRatMojo
-
Will skip the plugin execution, e.g.
- SourceCodeManagementSystems - Enum in org.apache.rat.config
-
- 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
-
- styleReport(PrintStream, ReportConfiguration) - Method in class org.apache.rat.Report
-
Output a report in the default style and default license
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
-