JavaScript is disabled on your browser.
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Prev
Next
Frames
No Frames
All Classes
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
R
S
T
U
W
X
Z
A
AbstractSingleClaimAnalyser
- Class in
rat.report.analyser
AbstractSingleClaimAnalyser(IClaimReporter, CharSequence, boolean)
- Constructor for class rat.report.analyser.
AbstractSingleClaimAnalyser
ACADEMIC_FREE_LICENSE_FAMILY
- Static variable in class rat.license.
AcademicFree21LicenseFamily
AcademicFree21LicenseFamily
- Class in
rat.license
AcademicFree21LicenseFamily()
- Constructor for class rat.license.
AcademicFree21LicenseFamily
add(ResourceCollection)
- Method in class rat.anttasks.
Report
Adds resources that will be checked.
add(IHeaderMatcher)
- Method in class rat.anttasks.
Report
Adds a license matcher.
add(ILicenseFamily)
- Method in class rat.anttasks.
Report
analyse(IDocument)
- Method in interface rat.document.
IDocumentAnalyser
analyse(IDocument)
- Method in class rat.document.impl.util.
ConditionalAnalyser
analyse(IDocument)
- Method in class rat.document.impl.util.
DocumentAnalyserMultiplexer
analyse(IDocument)
- Method in class rat.report.analyser.
AbstractSingleClaimAnalyser
analyse(IDocument)
- Method in class rat.report.analyser.
DocumentHeaderAnalyser
Apache20LicenseFamily
- Class in
rat.license
Apache20LicenseFamily()
- Constructor for class rat.license.
Apache20LicenseFamily
APACHE_SOFTWARE_LICENSE_NAME
- Static variable in class rat.license.
Apache20LicenseFamily
ApacheSoftwareLicense20
- Class in
rat.analysis.license
Matches Apache Software License, Version 2.0
ApacheSoftwareLicense20()
- Constructor for class rat.analysis.license.
ApacheSoftwareLicense20
ARCHIVE_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
ArchiveGuesser
ArchiveGuesser
- Class in
rat.document.impl.guesser
ArchiveGuesser()
- Constructor for class rat.document.impl.guesser.
ArchiveGuesser
ASCII_CHAR_THREASHOLD
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
ASL_CODE
- Static variable in class rat.analysis.
Claims
attribute(CharSequence, CharSequence)
- Method in class rat.report.xml.writer.impl.base.
XmlWriter
Writes an attribute of an element.
attribute(CharSequence, CharSequence)
- Method in interface rat.report.xml.writer.
IXmlWriter
Writes an attribute of an element.
B
BaseLicense
- Class in
rat.analysis.license
BaseLicense(String, String, String)
- Constructor for class rat.analysis.license.
BaseLicense
BinaryGuesser
- Class in
rat.document.impl.guesser
BinaryGuesser()
- Constructor for class rat.document.impl.guesser.
BinaryGuesser
BYTECODE_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
C
claim(CharSequence, CharSequence, CharSequence, boolean)
- Method in class rat.policy.
DefaultPolicy
claim(CharSequence, CharSequence, CharSequence, boolean)
- Method in interface rat.report.claim.
IClaimReporter
States a claim.
claim(CharSequence, CharSequence, CharSequence, boolean)
- Method in class rat.report.claim.impl.xml.
SimpleXmlClaimReporter
claim(CharSequence, CharSequence, CharSequence, boolean)
- Method in class rat.report.claim.util.
ClaimReporterMultiplexer
ClaimReporterMultiplexer
- Class in
rat.report.claim.util
ClaimReporterMultiplexer(IClaimReporter[])
- Constructor for class rat.report.claim.util.
ClaimReporterMultiplexer
Claims
- Class in
rat.analysis
Claims()
- Constructor for class rat.analysis.
Claims
closeDocument()
- Method in class rat.report.xml.writer.impl.base.
XmlWriter
Closes all pending elements.
closeDocument()
- Method in interface rat.report.xml.writer.
IXmlWriter
Closes all pending elements.
closeElement()
- Method in class rat.report.xml.writer.impl.base.
XmlWriter
Closes the last element written.
closeElement()
- Method in interface rat.report.xml.writer.
IXmlWriter
Closes the last element written.
CompositeDocument
- Class in
rat.document.impl
Composed from a set of archived documents.
CompositeDocument(String)
- Constructor for class rat.document.impl.
CompositeDocument
CompositeDocumentException
- Exception in
rat.document
Indicates that the document is a composite archive and cannot be read.
CompositeDocumentException()
- Constructor for exception rat.document.
CompositeDocumentException
CompositeDocumentException(String)
- Constructor for exception rat.document.
CompositeDocumentException
ConditionalAnalyser
- Class in
rat.document.impl.util
Analyses documents matching given condition.
ConditionalAnalyser(IDocumentMatcher, IDocumentAnalyser)
- Constructor for class rat.document.impl.util.
ConditionalAnalyser
ConstantClaimAnalyser
- Class in
rat.report.analyser
ConstantClaimAnalyser(IClaimReporter, CharSequence, CharSequence, boolean)
- Constructor for class rat.report.analyser.
ConstantClaimAnalyser
containsExtension(String, String[])
- Static method in class rat.document.impl.guesser.
BinaryGuesser
content(CharSequence)
- Method in class rat.report.xml.writer.impl.base.
XmlWriter
Writes content.
content(CharSequence)
- Method in interface rat.report.xml.writer.
IXmlWriter
Writes content.
createArchiveTypeAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createBinaryTypeAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultAnalyser(IClaimReporter, IHeaderMatcher)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultAnalyser(IDocumentAnalyser, IDocumentAnalyser, IDocumentAnalyser, IDocumentAnalyser)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultAnalyser(IDocumentAnalyser, IDocumentAnalyser, IDocumentAnalyser, IDocumentAnalyser, IDocumentMatcher, IDocumentMatcher, IDocumentMatcher)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultArchiveAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultBinaryAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultMatcher()
- Static method in class rat.
Defaults
createDefaultNoticeAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createDefaultStandardAnalyser(IClaimReporter, IHeaderMatcher)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createNoticeTypeAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
createStandardReport(IXmlWriter, IHeaderMatcher)
- Static method in class rat.report.xml.
XmlReportFactory
createStandardReport(IXmlWriter, IHeaderMatcher, ILicenseFamily[])
- Static method in class rat.report.xml.
XmlReportFactory
createStandardTypeAnalyser(IClaimReporter)
- Static method in class rat.report.analyser.
DefaultAnalyserFactory
D
DATA_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
DEFAULT_MATCHERS
- Static variable in class rat.
Defaults
The standard liest of licenses to include in the reports.
DefaultAnalyserFactory
- Class in
rat.report.analyser
Creates default analysers.
DefaultAnalyserFactory()
- Constructor for class rat.report.analyser.
DefaultAnalyserFactory
DefaultPolicy
- Class in
rat.policy
DefaultPolicy(IClaimReporter)
- Constructor for class rat.policy.
DefaultPolicy
DefaultPolicy(IClaimReporter, ILicenseFamily[])
- Constructor for class rat.policy.
DefaultPolicy
DefaultPolicy(IClaimReporter, String[])
- Constructor for class rat.policy.
DefaultPolicy
Defaults
- Class in
rat
Utility class that holds constants shared by the CLI tool and the Ant tasks.
DirectoryWalker
- Class in
rat
Walks directories.
DirectoryWalker(File)
- Constructor for class rat.
DirectoryWalker
DirectoryWalker(File, Pattern)
- Constructor for class rat.
DirectoryWalker
DocumentAnalyserMultiplexer
- Class in
rat.document.impl.util
DocumentAnalyserMultiplexer(IDocumentAnalyser[])
- Constructor for class rat.document.impl.util.
DocumentAnalyserMultiplexer
DocumentHeaderAnalyser
- Class in
rat.report.analyser
DocumentHeaderAnalyser(IHeaderMatcher, IClaimReporter)
- Constructor for class rat.report.analyser.
DocumentHeaderAnalyser
DocumentImplUtils
- Class in
rat.document.impl
DocumentImplUtils()
- Constructor for class rat.document.impl.
DocumentImplUtils
documentIterator()
- Method in interface rat.document.
IDocumentCollection
Iterates
IDocument
's contained.
DocumentMatcherMultiplexer
- Class in
rat.document.impl.util
Calls all the matchers in turn until one returns true.
DocumentMatcherMultiplexer(IDocumentMatcher[])
- Constructor for class rat.document.impl.util.
DocumentMatcherMultiplexer
documentsContained(IDocumentCollection)
- Static method in class rat.document.
DocumentUtils
Collects all the documents contained in the collection tree.
DocumentUtils
- Class in
rat.document
DocumentUtils()
- Constructor for class rat.document.
DocumentUtils
DOJO
- Static variable in class rat.analysis.
Claims
DojoLicenseHeader
- Class in
rat.analysis.license
DojoLicenseHeader()
- Constructor for class rat.analysis.license.
DojoLicenseHeader
E
endReport()
- Method in interface rat.report.
RatReport
EXE_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
execute()
- Method in class rat.anttasks.
Report
Generates the report.
extensionMatches(String, String[])
- Static method in class rat.document.impl.guesser.
BinaryGuesser
F
file
- Variable in class rat.
DirectoryWalker
FileDocument
- Class in
rat.document.impl
Document wrapping a file of undetermined composition.
FileDocument(File, IFileUnarchiver)
- Constructor for class rat.document.impl.
FileDocument
FIRST_LICENSE_LINE
- Static variable in class rat.analysis.license.
ApacheSoftwareLicense20
G
GeneratedLicenseNotRequired
- Class in
rat.analysis.generation
GeneratedLicenseNotRequired()
- Constructor for class rat.analysis.generation.
GeneratedLicenseNotRequired
GeneratedLicenseNotRequired(Pattern[])
- Constructor for class rat.analysis.generation.
GeneratedLicenseNotRequired
getCause()
- Method in exception rat.document.
UnreadableArchiveException
getCode()
- Method in class rat.analysis.license.
BaseLicense
getDefaultStyleSheet()
- Static method in class rat.
Defaults
getFamilyName()
- Method in class rat.license.
AcademicFree21LicenseFamily
getFamilyName()
- Method in class rat.license.
Apache20LicenseFamily
getFamilyName()
- Method in interface rat.license.
ILicenseFamily
getFamilyName()
- Method in class rat.license.
ModifiedBSDLicenseFamily
getFamilyName()
- Method in class rat.license.
OASISLicenseFamily
getFamilyName()
- Method in class rat.license.
W3CDocumentLicenseFamily
getFamilyName()
- Method in class rat.license.
W3CSoftwareLicenseFamily
getHeaderPattern()
- Method in class rat.header.
HeaderBean
Gets the header pattern to be matched.
getMessage()
- Method in exception rat.document.
UnreadableArchiveException
getMessage(int)
- Method in exception rat.document.
UnreadableArchiveException
getMessages()
- Method in exception rat.document.
UnreadableArchiveException
getName()
- Method in class rat.analysis.license.
BaseLicense
getName()
- Method in class rat.document.impl.
CompositeDocument
getName()
- Method in class rat.document.impl.
FileDocument
getName()
- Method in class rat.document.impl.
MonolithicFileDocument
getName()
- Method in class rat.document.impl.zip.
ZipRootDirectory
getName()
- Method in interface rat.document.
IResource
getNotes()
- Method in class rat.analysis.license.
BaseLicense
getPlainStyleSheet()
- Static method in class rat.
Defaults
getThrowable(int)
- Method in exception rat.document.
UnreadableArchiveException
getThrowableCount()
- Method in exception rat.document.
UnreadableArchiveException
getThrowables()
- Method in exception rat.document.
UnreadableArchiveException
getURL()
- Method in class rat.document.impl.zip.
ZipRootDirectory
GuessUtils
- Class in
rat.document.impl.guesser
GuessUtils()
- Constructor for class rat.document.impl.guesser.
GuessUtils
H
HEADER_SAMPLE_PREDICATE
- Static variable in class rat.analysis.
Claims
HEADER_TYPE_PREDICATE
- Static variable in class rat.analysis.
Claims
HeaderBean
- Class in
rat.header
HeaderBean()
- Constructor for class rat.header.
HeaderBean
HeaderBean(Pattern, boolean)
- Constructor for class rat.header.
HeaderBean
HeaderMatcher
- Class in
rat.header
Matches headers.
HeaderMatcher(CharFilter, int)
- Constructor for class rat.header.
HeaderMatcher
HeaderMatcher(CharFilter, int, HeaderBean[])
- Constructor for class rat.header.
HeaderMatcher
HeaderMatcherMultiplexer
- Class in
rat.analysis.util
Delegates to an ordered set of matchers.
HeaderMatcherMultiplexer(IHeaderMatcher[])
- Constructor for class rat.analysis.util.
HeaderMatcherMultiplexer
HIGH_BYTES_RATIO
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
I
IClaimReporter
- Interface in
rat.report.claim
IDocument
- Interface in
rat.document
IDocumentAnalyser
- Interface in
rat.document
IDocumentCollection
- Interface in
rat.document
Collects documents.
IDocumentMatcher
- Interface in
rat.document
IFileUnarchiver
- Interface in
rat.document
Reads documents from file archives.
ignored(String)
- Method in class rat.
DirectoryWalker
IHeaderMatcher
- Interface in
rat.analysis
Matches text headers to known licenses.
ILicenseFamily
- Interface in
rat.license
IMAGE_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
indexOfThrowable(Class)
- Method in exception rat.document.
UnreadableArchiveException
indexOfThrowable(Class, int)
- Method in exception rat.document.
UnreadableArchiveException
InvalidXmlException
- Exception in
rat.report.xml.writer
Indicates that the requested document would not be well formed.
InvalidXmlException(String)
- Constructor for exception rat.report.xml.writer.
InvalidXmlException
IReportable
- Interface in
rat.report
IResource
- Interface in
rat.document
isArchive(String)
- Static method in class rat.document.impl.guesser.
ArchiveGuesser
Is a file by that name an archive?
isBinary(Reader)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
Do the first few bytes of the stream hint at a binary file?
isBinary(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
Is a file by that name a known binary file?
isBinaryData(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
isBytecode(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
isExecutable(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
isImage(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
isKeystore(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
isMatch()
- Method in class rat.header.
HeaderBean
isNonBinary(String)
- Static method in class rat.document.impl.guesser.
BinaryGuesser
Is a file by that name a known non-binary file?
isNote(String)
- Static method in class rat.document.impl.guesser.
NoteGuesser
Is a file by that name a note file?
isRestricted()
- Method in class rat.
DirectoryWalker
IXmlWriter
- Interface in
rat.report.xml.writer
Simple interface for creating basic xml documents.
J
JAR_MANIFEST
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
JAVA
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
JavaDocLicenseNotRequired
- Class in
rat.analysis.generation
JavaDocs are generated and so no license is required.
JavaDocLicenseNotRequired()
- Constructor for class rat.analysis.generation.
JavaDocLicenseNotRequired
K
KEYSTORE_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
L
LICENSE_APPROVAL_PREDICATE
- Static variable in class rat.analysis.
Claims
LICENSE_FAMILY_PREDICATE
- Static variable in class rat.analysis.
Claims
LICENSE_REFERENCE_LINE
- Static variable in class rat.analysis.license.
ApacheSoftwareLicense20
lines()
- Method in class rat.header.
HeaderMatcher
Number of lines read.
load(File)
- Static method in class rat.document.impl.zip.
ZipDocumentFactory
M
main(String[])
- Static method in class rat.
Report
match(String, String, IClaimReporter)
- Method in class rat.analysis.generation.
GeneratedLicenseNotRequired
match(String, String, IClaimReporter)
- Method in class rat.analysis.generation.
JavaDocLicenseNotRequired
match(String, String, IClaimReporter)
- Method in interface rat.analysis.
IHeaderMatcher
Matches the text accumulated to licenses.
match(String, String, IClaimReporter)
- Method in class rat.analysis.license.
ApacheSoftwareLicense20
match(String, String, IClaimReporter)
- Method in class rat.analysis.license.
DojoLicenseHeader
match(String, String, IClaimReporter)
- Method in class rat.analysis.license.
OASISLicense
match(String, String, IClaimReporter)
- Method in class rat.analysis.license.
W3CDocLicense
match(String, String, IClaimReporter)
- Method in class rat.analysis.license.
W3CLicense
match(String, String, IClaimReporter)
- Method in class rat.analysis.util.
HeaderMatcherMultiplexer
matches(IDocument)
- Method in interface rat.document.
IDocumentMatcher
matches(IDocument)
- Method in class rat.document.impl.guesser.
ArchiveGuesser
matches(IDocument)
- Method in class rat.document.impl.guesser.
BinaryGuesser
matches(IDocument)
- Method in class rat.document.impl.guesser.
NoteGuesser
matches(IDocument)
- Method in class rat.document.impl.util.
ConditionalAnalyser
matches(IDocument)
- Method in class rat.document.impl.util.
DocumentMatcherMultiplexer
matches(IDocument)
- Method in class rat.document.impl.util.
MatchNegator
matches(Pattern)
- Method in class rat.header.
HeaderMatcher
Seeks a match in the last headers read.
MatchNegator
- Class in
rat.document.impl.util
Negatives the result of the given matcher.
MatchNegator(IDocumentMatcher)
- Constructor for class rat.document.impl.util.
MatchNegator
MODIFIED_BSD_LICENSE_NAME
- Static variable in class rat.license.
ModifiedBSDLicenseFamily
ModifiedBSDLicenseFamily
- Class in
rat.license
ModifiedBSDLicenseFamily()
- Constructor for class rat.license.
ModifiedBSDLicenseFamily
MonolithicFileDocument
- Class in
rat.document.impl
MonolithicFileDocument(File)
- Constructor for class rat.document.impl.
MonolithicFileDocument
N
name
- Variable in class rat.
DirectoryWalker
NON_ASCII_THREASHOLD
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
NON_BINARY_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
Based on http://www.apache.org/dev/svn-eol-style.txt
normalise(String)
- Static method in class rat.document.impl.guesser.
GuessUtils
Converts name to upper case and strips any path.
NOTE_FILE_EXTENSIONS
- Static variable in class rat.document.impl.guesser.
NoteGuesser
NOTE_FILE_NAMES
- Static variable in class rat.document.impl.guesser.
NoteGuesser
NoteGuesser
- Class in
rat.document.impl.guesser
NoteGuesser()
- Constructor for class rat.document.impl.guesser.
NoteGuesser
O
OASIS_CODE
- Static variable in class rat.analysis.
Claims
OASIS_OPEN_LICENSE_NAME
- Static variable in class rat.license.
OASISLicenseFamily
OASISLicense
- Class in
rat.analysis.license
Looks for documents contain the OASIS copyright claim plus derivative work clause.
OASISLicense()
- Constructor for class rat.analysis.license.
OASISLicense
OASISLicenseFamily
- Class in
rat.license
OASISLicenseFamily()
- Constructor for class rat.license.
OASISLicenseFamily
openElement(CharSequence)
- Method in class rat.report.xml.writer.impl.base.
XmlWriter
Writes the start of an element.
openElement(CharSequence)
- Method in interface rat.report.xml.writer.
IXmlWriter
Writes the start of an element.
OperationNotAllowedException
- Exception in
rat.report.xml.writer
Thrown by
IXmlWriter
implementations when the current state does not allow the requested operation.
OperationNotAllowedException(String)
- Constructor for exception rat.report.xml.writer.
OperationNotAllowedException
P
PLAIN_STYLESHEET
- Static variable in class rat.
Defaults
printPartialStackTrace(PrintWriter)
- Method in exception rat.document.
UnreadableArchiveException
printStackTrace()
- Method in exception rat.document.
UnreadableArchiveException
printStackTrace(PrintStream)
- Method in exception rat.document.
UnreadableArchiveException
printStackTrace(PrintWriter)
- Method in exception rat.document.
UnreadableArchiveException
R
rat
- package rat
rat.analysis
- package rat.analysis
rat.analysis.generation
- package rat.analysis.generation
rat.analysis.license
- package rat.analysis.license
rat.analysis.util
- package rat.analysis.util
rat.anttasks
- package rat.anttasks
rat.document
- package rat.document
rat.document.impl
- package rat.document.impl
rat.document.impl.guesser
- package rat.document.impl.guesser
rat.document.impl.util
- package rat.document.impl.util
rat.document.impl.zip
- package rat.document.impl.zip
rat.header
- package rat.header
rat.license
- package rat.license
rat.policy
- package rat.policy
rat.report
- package rat.report
rat.report.analyser
- package rat.report.analyser
rat.report.claim
- package rat.report.claim
rat.report.claim.impl.xml
- package rat.report.claim.impl.xml
rat.report.claim.util
- package rat.report.claim.util
rat.report.xml
- package rat.report.xml
rat.report.xml.writer
- package rat.report.xml.writer
rat.report.xml.writer.impl.base
- package rat.report.xml.writer.impl.base
RatDocumentAnalysisException
- Exception in
rat.document
RatDocumentAnalysisException()
- Constructor for exception rat.document.
RatDocumentAnalysisException
RatDocumentAnalysisException(String)
- Constructor for exception rat.document.
RatDocumentAnalysisException
RatDocumentAnalysisException(Throwable)
- Constructor for exception rat.document.
RatDocumentAnalysisException
RatDocumentAnalysisException(String, Throwable)
- Constructor for exception rat.document.
RatDocumentAnalysisException
RatHeaderAnalysisException
- Exception in
rat.analysis
Indicates exceptional condition during header analysis.
RatHeaderAnalysisException()
- Constructor for exception rat.analysis.
RatHeaderAnalysisException
RatHeaderAnalysisException(String, Throwable)
- Constructor for exception rat.analysis.
RatHeaderAnalysisException
RatHeaderAnalysisException(String)
- Constructor for exception rat.analysis.
RatHeaderAnalysisException
RatHeaderAnalysisException(Throwable)
- Constructor for exception rat.analysis.
RatHeaderAnalysisException
RatReport
- Interface in
rat.report
RatReportAnalysisResultException
- Exception in
rat.report.analyser
RatReportAnalysisResultException()
- Constructor for exception rat.report.analyser.
RatReportAnalysisResultException
RatReportAnalysisResultException(RatReportFailedException)
- Constructor for exception rat.report.analyser.
RatReportAnalysisResultException
RatReportAnalysisResultException(String, RatReportFailedException)
- Constructor for exception rat.report.analyser.
RatReportAnalysisResultException
RatReportFailedException
- Exception in
rat.report
RatReportFailedException()
- Constructor for exception rat.report.
RatReportFailedException
RatReportFailedException(String, Throwable)
- Constructor for exception rat.report.
RatReportFailedException
RatReportFailedException(String)
- Constructor for exception rat.report.
RatReportFailedException
RatReportFailedException(Throwable)
- Constructor for exception rat.report.
RatReportFailedException
read(Reader)
- Method in class rat.header.
HeaderMatcher
READABLE_ARCHIVE_VALUE
- Static variable in class rat.report.analyser.
ReadableArchiveAnalyser
ReadableArchiveAnalyser
- Class in
rat.report.analyser
ReadableArchiveAnalyser(IClaimReporter)
- Constructor for class rat.report.analyser.
ReadableArchiveAnalyser
readArchive()
- Method in interface rat.document.
IDocument
Reads contents of composite document.
readArchive()
- Method in class rat.document.impl.
FileDocument
readArchive()
- Method in class rat.document.impl.
MonolithicFileDocument
readArchive()
- Method in class rat.document.impl.zip.
ZipFileDocument
reader()
- Method in interface rat.document.
IDocument
Reads the content of this document.
reader()
- Method in class rat.document.impl.
CompositeDocument
reader()
- Method in class rat.document.impl.
FileDocument
reader()
- Method in class rat.document.impl.
MonolithicFileDocument
Report
- Class in
rat.anttasks
A basic Ant task that generates a report on all files specified by the nested resource collection(s).
Report()
- Constructor for class rat.anttasks.
Report
Report
- Class in
rat
report(IDocument)
- Method in interface rat.report.
RatReport
report(PrintStream)
- Method in class rat.
Report
report(PrintStream, IReportable, InputStream, IHeaderMatcher, ILicenseFamily[])
- Static method in class rat.
Report
report(Writer, IReportable, InputStream, IHeaderMatcher, ILicenseFamily[])
- Static method in class rat.
Report
report(IReportable, Writer, IHeaderMatcher, ILicenseFamily[])
- Static method in class rat.
Report
reportGeneratedClaims(String, String, IClaimReporter)
- Static method in class rat.analysis.
Claims
reportGeneratedHeaderTypeClaim(String, IClaimReporter)
- Static method in class rat.analysis.
Claims
reportHeaderSampleClaim(String, String, IClaimReporter)
- Static method in class rat.analysis.
Claims
reportHeaderTypeClaim(String, String, IClaimReporter)
- Static method in class rat.analysis.
Claims
reportLicenseApprovalClaim(CharSequence, boolean, IClaimReporter)
- Static method in class rat.analysis.
Claims
reportOnLicense(String, IClaimReporter)
- Method in class rat.analysis.license.
BaseLicense
reportStandardClaims(String, String, String, String, IClaimReporter)
- Static method in class rat.analysis.
Claims
reset()
- Method in class rat.analysis.generation.
GeneratedLicenseNotRequired
reset()
- Method in class rat.analysis.generation.
JavaDocLicenseNotRequired
reset()
- Method in interface rat.analysis.
IHeaderMatcher
Resets this matches.
reset()
- Method in class rat.analysis.license.
ApacheSoftwareLicense20
reset()
- Method in class rat.analysis.license.
DojoLicenseHeader
reset()
- Method in class rat.analysis.license.
OASISLicense
reset()
- Method in class rat.analysis.license.
W3CDocLicense
reset()
- Method in class rat.analysis.license.
W3CLicense
reset()
- Method in class rat.analysis.util.
HeaderMatcherMultiplexer
run(RatReport)
- Method in class rat.
DirectoryWalker
run(RatReport)
- Method in interface rat.report.
IReportable
S
setAddDefaultLicenseMatchers(boolean)
- Method in class rat.anttasks.
Report
Whether to add the default list of license matchers.
setHeaderPattern(Pattern)
- Method in class rat.header.
HeaderBean
Sets the header pattern to be matched.
setMatch(boolean)
- Method in class rat.header.
HeaderBean
setReportFile(File)
- Method in class rat.anttasks.
Report
Where to send the report to.
SimpleXmlClaimReporter
- Class in
rat.report.claim.impl.xml
SimpleXmlClaimReporter(IXmlWriter)
- Constructor for class rat.report.claim.impl.xml.
SimpleXmlClaimReporter
startDocument()
- Method in class rat.report.xml.writer.impl.base.
XmlWriter
Starts a document by writing a prolog.
startDocument()
- Method in interface rat.report.xml.writer.
IXmlWriter
Starts a document by writing a prolog.
startReport()
- Method in interface rat.report.
RatReport
styleReport(PrintStream)
- Method in class rat.
Report
subcollectionIterator()
- Method in interface rat.document.
IDocumentCollection
Iterates
IDocumentCollection
's contained.
T
toName(File)
- Static method in class rat.document.impl.
DocumentImplUtils
toNameTransformer()
- Static method in class rat.document.
DocumentUtils
toObject(IDocument)
- Method in class rat.report.analyser.
AbstractSingleClaimAnalyser
toObject(IDocument)
- Method in class rat.report.analyser.
ConstantClaimAnalyser
toObject(IDocument)
- Method in class rat.report.analyser.
ReadableArchiveAnalyser
TOTAL_READ_RATIO
- Static variable in class rat.document.impl.guesser.
BinaryGuesser
U
unarchive(File)
- Method in interface rat.document.
IFileUnarchiver
Unarchives the file.
unarchive(File)
- Method in class rat.document.impl.zip.
ZipFileUnarchiver
UNREADABLE_ARCHIVE_VALUE
- Static variable in class rat.report.analyser.
ReadableArchiveAnalyser
UnreadableArchiveException
- Exception in
rat.document
Indicates that an archive is unreadable.
UnreadableArchiveException()
- Constructor for exception rat.document.
UnreadableArchiveException
UnreadableArchiveException(String)
- Constructor for exception rat.document.
UnreadableArchiveException
UnreadableArchiveException(Throwable)
- Constructor for exception rat.document.
UnreadableArchiveException
UnreadableArchiveException(String, Throwable)
- Constructor for exception rat.document.
UnreadableArchiveException
UnsuitableDocumentException
- Exception in
rat.document
Indicates that the document was unsuitable for analysis.
UnsuitableDocumentException()
- Constructor for exception rat.document.
UnsuitableDocumentException
UnsuitableDocumentException(String, Throwable)
- Constructor for exception rat.document.
UnsuitableDocumentException
UnsuitableDocumentException(String)
- Constructor for exception rat.document.
UnsuitableDocumentException
UnsuitableDocumentException(Throwable)
- Constructor for exception rat.document.
UnsuitableDocumentException
W
W3C_CODE
- Static variable in class rat.analysis.
Claims
W3C_DOCUMENT_COPYRIGHT_NAME
- Static variable in class rat.license.
W3CDocumentLicenseFamily
W3C_SOFTWARE_COPYRIGHT_NAME
- Static variable in class rat.license.
W3CSoftwareLicenseFamily
W3CD_CODE
- Static variable in class rat.analysis.
Claims
W3CDocLicense
- Class in
rat.analysis.license
W3CDocLicense()
- Constructor for class rat.analysis.license.
W3CDocLicense
W3CDocumentLicenseFamily
- Class in
rat.license
W3CDocumentLicenseFamily()
- Constructor for class rat.license.
W3CDocumentLicenseFamily
W3CLicense
- Class in
rat.analysis.license
W3CLicense()
- Constructor for class rat.analysis.license.
W3CLicense
W3CSoftwareLicenseFamily
- Class in
rat.license
W3CSoftwareLicenseFamily()
- Constructor for class rat.license.
W3CSoftwareLicenseFamily
writeAttribute(IXmlWriter, String, boolean)
- Static method in class rat.report.xml.writer.
XmlWriterUtils
X
XmlReportFactory
- Class in
rat.report.xml
Creates reports.
XmlReportFactory()
- Constructor for class rat.report.xml.
XmlReportFactory
XmlWriter
- Class in
rat.report.xml.writer.impl.base
Lightweight
IXmlWriter
implementation.
XmlWriter(Writer)
- Constructor for class rat.report.xml.writer.impl.base.
XmlWriter
XmlWriterUtils
- Class in
rat.report.xml.writer
XmlWriterUtils()
- Constructor for class rat.report.xml.writer.
XmlWriterUtils
Z
ZipDocumentFactory
- Class in
rat.document.impl.zip
ZipDocumentFactory()
- Constructor for class rat.document.impl.zip.
ZipDocumentFactory
ZipFileDocument
- Class in
rat.document.impl.zip
Document which is a zip file.
ZipFileDocument(File)
- Constructor for class rat.document.impl.zip.
ZipFileDocument
ZipFileUnarchiver
- Class in
rat.document.impl.zip
ZipFileUnarchiver()
- Constructor for class rat.document.impl.zip.
ZipFileUnarchiver
ZipRootDirectory
- Class in
rat.document.impl.zip
ZipRootDirectory(ZipFile, Collection, Collection)
- Constructor for class rat.document.impl.zip.
ZipRootDirectory
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
R
S
T
U
W
X
Z
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Prev
Next
Frames
No Frames
All Classes
Copyright © 2006–2015. All rights reserved.