Uses of Class
org.apache.rat.document.impl.DocumentName

Packages that use DocumentName

Package	Description
org.apache.rat	The base package for the RAT tool.
org.apache.rat.api	Key abstractions.
org.apache.rat.config.exclusion	Classes that manage the inclusion and exclusion of files.
org.apache.rat.config.exclusion.fileProcessors	Custom file processors to handles exclusions defined in various formats.
org.apache.rat.document.impl	Implementations of the Document interface.
org.apache.rat.report
org.apache.rat.walker	Classes that walk directory trees and return documents.

Uses of DocumentName in org.apache.rat

Methods in org.apache.rat with parameters of type DocumentName

Modifier and Type	Method	Description
DocumentNameMatcher	ReportConfiguration.getNameMatcher(DocumentName baseDir)	Get the DocumentNameMatcher based on the directory.

Uses of DocumentName in org.apache.rat.api

Fields in org.apache.rat.api declared as DocumentName

Modifier and Type	Field	Description
protected final DocumentName	Document.name	The fully qualified name of this document

Methods in org.apache.rat.api that return DocumentName

Modifier and Type	Method	Description
final DocumentName	Document.getName()	Gets the name of the current document.

Constructors in org.apache.rat.api with parameters of type DocumentName

Modifier	Constructor	Description
protected	Document(DocumentName name, DocumentNameMatcher nameMatcher)	Creates an instance.

Uses of DocumentName in org.apache.rat.config.exclusion

Methods in org.apache.rat.config.exclusion that return DocumentName

Modifier and Type	Method	Description
static DocumentName	FileProcessor.localizePattern(DocumentName baseName, String pattern)	Modifies the MatchPattern formatted pattern argument by expanding the pattern and by adjusting the pattern to include the basename from the basename argument.

Methods in org.apache.rat.config.exclusion with parameters of type DocumentName

Modifier and Type	Method	Description
static FileFilter	ExclusionUtils.asFileFilter(DocumentName parent, DocumentNameMatcher nameMatcher)	Create a FileFilter from a PathMatcher.
DocumentNameMatcher	ExclusionProcessor.getNameMatcher(DocumentName basedir)	Creates a Document name matcher that will return false on any document that is excluded.
static DocumentName	FileProcessor.localizePattern(DocumentName baseName, String pattern)	Modifies the MatchPattern formatted pattern argument by expanding the pattern and by adjusting the pattern to include the basename from the basename argument.
default String	FileProcessor.modifyEntry(DocumentName documentName, String entry)	Allows modification of the file entry to match the MatchPattern format.

Uses of DocumentName in org.apache.rat.config.exclusion.fileProcessors

Methods in org.apache.rat.config.exclusion.fileProcessors with parameters of type DocumentName

Modifier and Type	Method	Description
List<String>	DescendingFileProcessor.apply(DocumentName dir)
String	BazaarIgnoreProcessor.modifyEntry(DocumentName baseName, String entry)
String	GitFileProcessor.modifyEntry(DocumentName documentName, String entry)
String	HgIgnoreProcessor.modifyEntry(DocumentName baseName, String entry)
protected List<String>	CVSFileProcessor.process(DocumentName documentName)
protected List<String>	DescendingFileProcessor.process(DocumentName documentName)	Process by reading the file and return a list of properly formatted patterns.
protected List<String>	HgIgnoreProcessor.process(DocumentName baseName)

Uses of DocumentName in org.apache.rat.document.impl

Methods in org.apache.rat.document.impl that return DocumentName

Modifier and Type	Method	Description
DocumentName	DocumentName.getBaseDocumentName()	Gets the DocumentName for the basename of this document name.
DocumentName	DocumentName.resolve(String child)	Creates a new document name by adding the child to the current name.

Methods in org.apache.rat.document.impl with parameters of type DocumentName

Modifier and Type	Method	Description
int	DocumentName.compareTo(DocumentName o)
DocumentNameMatcher	DocumentNameMatcherSupplier.get(DocumentName dir)
boolean	DocumentNameMatcher.matches(DocumentName documentName)
boolean	TraceableDocumentNameMatcher.matches(DocumentName documentName)

Constructors in org.apache.rat.document.impl with parameters of type DocumentName

Modifier	Constructor	Description
	ArchiveEntryDocument(DocumentName outerName, byte[] contents, DocumentNameMatcher nameMatcher)	Creates an Archive entry.
	DocumentName(File file, DocumentName baseName)	Creates a document name with the name of the file and the same basename as the baseName document.
	FileDocument(DocumentName basedir, File file, DocumentNameMatcher nameMatcher)	Creates a File document.

Uses of DocumentName in org.apache.rat.report

Methods in org.apache.rat.report that return DocumentName

Modifier and Type	Method	Description
DocumentName	IReportable.getName()	Returns the DocumentName for the reportable.

Uses of DocumentName in org.apache.rat.walker

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

Modifier and Type	Method	Description
DocumentName	Walker.getName()