- 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.SimplePatternBasedLicense
-
- getLicenseFamilyName() - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
-
- 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
-
- 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.SimplePatternBasedLicense
-
- 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
-
- GuessUtils - Class in org.apache.rat.document.impl.guesser
-
- GuessUtils() - Constructor for class org.apache.rat.document.impl.guesser.GuessUtils
-
- 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.
- 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.
- 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.SimplePatternBasedLicense
-
- setLicenseFamilyName(String) - Method in class org.apache.rat.analysis.license.SimplePatternBasedLicense
-
- 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.SimplePatternBasedLicense
-
- 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
-
- 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
-