Uses of Class
org.apache.rat.document.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.commandline	Helper classes for command line processing.
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	The definitions of Documents and their analysers.
org.apache.rat.report	Classes that generate the 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.getDocumentExcluder(DocumentName baseDir)	Get the DocumentNameMatcher that excludes files found in the directory tree..

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.commandline

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

Modifier and Type	Method	Description
DocumentName	ArgumentContext.getWorkingDirectory()	Gets the directory name from which relative file names will be resolved.

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

Modifier and Type	Method	Description
void	Converters.FileConverter.setWorkingDirectory(DocumentName workingDirectory)	Sets the working directory for the conversion.

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

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

Modifier and Type	Method	Description
MatcherSet.Builder	MatcherSet.Builder.addExcluded(DocumentName fromDocument, Set<String> names)	Adds excluded file names from the specified document.
MatcherSet.Builder	MatcherSet.Builder.addIncluded(DocumentName fromDocument, Set<String> names)	Adds included file names from the specified document.
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 String	ExclusionUtils.qualifyPattern(DocumentName documentName, String pattern)	Modifies the MatchPattern formatted pattern argument by expanding the pattern and by adjusting the pattern to include the basename from the documentName argument.

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
final List<MatcherSet>	AbstractFileProcessorBuilder.build(DocumentName root)	Builder the list of MatcherSet that define the inclusions/exclusions for the file processor.
protected Optional<String>	AbstractFileProcessorBuilder.modifyEntry(Consumer<MatcherSet> matcherSetConsumer, DocumentName documentName, String entry)	Allows modification of the file entry to match the MatchPattern format.
Optional<String>	BazaarIgnoreBuilder.modifyEntry(Consumer<MatcherSet> matcherSetConsumer, DocumentName baseName, String entry)
protected Optional<String>	GitIgnoreBuilder.modifyEntry(Consumer<MatcherSet> matcherSetConsumer, DocumentName documentName, String entry)	Convert the string entry.
Optional<String>	HgIgnoreBuilder.modifyEntry(Consumer<MatcherSet> matcherSetConsumer, DocumentName documentName, String entry)
protected MatcherSet	AbstractFileProcessorBuilder.process(Consumer<MatcherSet> matcherSetConsumer, DocumentName root, DocumentName documentName)	Process by reading the file, creating a MatcherSet, and adding it to the matcherSets.
protected MatcherSet	CVSIgnoreBuilder.process(Consumer<MatcherSet> matcherSetConsumer, DocumentName root, DocumentName documentName)
protected MatcherSet	HgIgnoreBuilder.process(Consumer<MatcherSet> matcherSetConsumer, DocumentName root, DocumentName documentName)

Uses of DocumentName in org.apache.rat.document

Subclasses of DocumentName in org.apache.rat.document

Modifier and Type	Class	Description
class	ArchiveEntryName

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

Modifier and Type	Method	Description
DocumentName	DocumentName.Builder.build()	Build a DocumentName from this builder.
DocumentName	DocumentName.getBaseDocumentName()	Gets the DocumentName for the basename of this DocumentName.
DocumentName	ArchiveEntryName.resolve(String child)
DocumentName	DocumentName.resolve(String child)	Creates a new DocumentName by adding the child to the current name.

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

Modifier and Type	Method	Description
Predicate<DocumentName>	DocumentNameMatcher.getPredicate()	Returns the predicate that this DocumentNameMatcher is using.

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

Modifier and Type	Method	Description
static DocumentName.Builder	DocumentName.builder(DocumentName documentName)	Creates a builder from a document name.
int	DocumentName.compareTo(DocumentName other)
List<DocumentNameMatcher.DecomposeData>	DocumentNameMatcher.decompose(DocumentName candidate)	Decomposes the matcher execution against the candidate.
boolean	DocumentNameMatcher.matches(DocumentName documentName)	Performs the match against the DocumentName.
DocumentName.Builder	DocumentName.Builder.setBaseName(DocumentName baseName)	Sets the basename from the DocumentName.Builder.name of the specified DocumentName.
boolean	DocumentNameMatcher.FileFilterPredicate.test(DocumentName documentName)
boolean	DocumentNameMatcher.MatchPatternsPredicate.test(DocumentName documentName)
boolean	DocumentNameMatcher.NotPredicate.test(DocumentName documentName)

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

Modifier	Constructor	Description
	ArchiveEntryName(DocumentName archiveFileName, String archiveEntryName)
	DocumentNameMatcher(String name, MatchPatterns patterns, DocumentName basedir)	Constructs a DocumentNameMatcher from a name a MatchPatterns instance and the DocumentName for the base name.
	FileDocument(DocumentName basedir, File file, DocumentNameMatcher nameMatcher)	Creates a File document.
	IgnoredDocument(DocumentName basedir, File file, DocumentNameMatcher nameMatcher)	Creates a File document.

Constructor parameters in org.apache.rat.document with type arguments of type DocumentName

Modifier	Constructor	Description
	DocumentNameMatcher(String name, Predicate<DocumentName> predicate)	Constructs a DocumentNameMatcher from a name and a DocumentName predicate.

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	FileListWalker.getName()
DocumentName	IReportableListWalker.getName()
DocumentName	Walker.getName()

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

Modifier and Type	Method	Description
static IReportableListWalker.Builder	IReportableListWalker.builder(DocumentName name)	Create a builder for the list walker.