Uses of Class
org.apache.rat.api.Document

Packages that use Document

Package	Description
org.apache.rat.analysis	Classes that perform analyses of files.
org.apache.rat.api	Key abstractions.
org.apache.rat.document	The definitions of Documents and their analysers.
org.apache.rat.document.guesser	Classes that attempt to determine if a file is a specific type of file.
org.apache.rat.report	Classes that generate the Rat report.
org.apache.rat.report.claim	Classes that manage claims (metrics) about files and categories of files.
org.apache.rat.report.xml	Classes that write the XML output.
org.apache.rat.walker	Classes that walk directory trees and return documents.

Uses of Document in org.apache.rat.analysis

Methods in org.apache.rat.analysis with parameters of type Document

Modifier and Type	Method	Description
static String	TikaProcessor.process(Document document)	Process the input document.

Constructors in org.apache.rat.analysis with parameters of type Document

Modifier	Constructor	Description
	HeaderCheckWorker(IHeaderMatcher generatedMatcher, Reader reader, int numberOfRetainedHeaderLine, Collection<ILicense> licenses, Document document)	Constructs a check worker for the license against the specified document.
	HeaderCheckWorker(IHeaderMatcher generatedMatcher, Reader reader, Collection<ILicense> licenses, Document name)	Convenience constructor wraps given Reader in a BufferedReader.

Uses of Document in org.apache.rat.api

Methods in org.apache.rat.api that return types with arguments of type Document

Modifier and Type	Method	Description
abstract SortedSet<Document>	Document.listChildren()	Gets a sorted set of documents that are children of this document.

Methods in org.apache.rat.api with parameters of type Document

Modifier and Type	Method	Description
int	Document.compareTo(Document doc)

Uses of Document in org.apache.rat.document

Subclasses of Document in org.apache.rat.document

Modifier and Type	Class	Description
class	ArchiveEntryDocument	A Document that wraps an Archive entry.
class	FileDocument	Document wrapping a File object.
class	IgnoredDocument	Document wrapping a File object that is ignored by rule.

Methods in org.apache.rat.document that return types with arguments of type Document

Modifier and Type	Method	Description
SortedSet<Document>	ArchiveEntryDocument.listChildren()
SortedSet<Document>	FileDocument.listChildren()
SortedSet<Document>	IgnoredDocument.listChildren()

Methods in org.apache.rat.document with parameters of type Document

Modifier and Type	Method	Description
void	DocumentAnalyser.analyse(Document document)	Analyse the specified document.

Uses of Document in org.apache.rat.document.guesser

Methods in org.apache.rat.document.guesser with parameters of type Document

Modifier and Type	Method	Description
static boolean	NoteGuesser.isNote(Document document)	Determines if the document is a note.

Uses of Document in org.apache.rat.report

Methods in org.apache.rat.report with parameters of type Document

Modifier and Type	Method	Description
void	AbstractReport.report(Document document)	Deprecated. Empty default implementation.
default void	RatReport.report(Document document)	Performs the actual reporting on the given document.

Uses of Document in org.apache.rat.report.claim

Methods in org.apache.rat.report.claim with parameters of type Document

Modifier and Type	Method	Description
void	AbstractClaimReporter.report(Document subject)
void	ClaimReporterMultiplexer.report(Document document)
void	LicenseAddingReport.report(Document document)
void	SimpleXmlClaimReporter.report(Document document)

Uses of Document in org.apache.rat.report.xml

Methods in org.apache.rat.report.xml with parameters of type Document

Modifier and Type	Method	Description
XmlElements	XmlElements.document(Document document)	Creates a document element with attributes.

Uses of Document in org.apache.rat.walker

Methods in org.apache.rat.walker that return Document

Modifier and Type	Method	Description
protected Document	Walker.getDocument()	Retrieves the document from the constructor.

Methods in org.apache.rat.walker that return types with arguments of type Document

Modifier and Type	Method	Description
Collection<Document>	ArchiveWalker.getDocuments()	Retrieves the documents from the archive.

Methods in org.apache.rat.walker with parameters of type Document

Modifier and Type	Method	Description
protected void	DirectoryWalker.process(RatReport report, Document document)	Process a directory, ignoring any files/directories set to be ignored.

Constructors in org.apache.rat.walker with parameters of type Document

Modifier	Constructor	Description
	ArchiveWalker(Document document)	Constructs a walker.
	DirectoryWalker(Document document)	Constructs a directory walker.
protected	Walker(Document document)	Creates the walker