Uses of Class
org.apache.rat.document.DocumentNameMatcher

Packages that use DocumentNameMatcher

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.document	The definitions of Documents and their analysers.

Uses of DocumentNameMatcher in org.apache.rat

Methods in org.apache.rat that return DocumentNameMatcher

Modifier and Type	Method	Description
DocumentNameMatcher	ReportConfiguration.getDocumentExcluder(DocumentName baseDir)	Get the DocumentNameMatcher that excludes files found in the directory tree..

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

Modifier and Type	Method	Description
void	ReportConfiguration.addExcludedMatcher(DocumentNameMatcher matcher)	Excludes files that match a DocumentNameMatcher.

Uses of DocumentNameMatcher in org.apache.rat.api

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

Modifier and Type	Field	Description
protected DocumentNameMatcher	Document.nameMatcher	The path matcher used by this document

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

Modifier and Type	Method	Description
DocumentNameMatcher	Document.getNameMatcher()	Gets the file filter this document was created with.

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

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

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

Fields in org.apache.rat.config.exclusion declared as DocumentNameMatcher

Modifier and Type	Field	Description
protected DocumentNameMatcher	MatcherSet.Builder.excluded	The DocumentNameMatcher that specifies excluded files
protected DocumentNameMatcher	MatcherSet.Builder.included	The DocumentNameMatcher that specifies included files

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

Modifier and Type	Method	Description
default DocumentNameMatcher	MatcherSet.createMatcher()	Creates a DocumentNameMatcher from an iterable of matcher sets.
DocumentNameMatcher	ExclusionProcessor.getNameMatcher(DocumentName basedir)	Creates a Document name matcher that will return false on any document that is excluded.
DocumentNameMatcher	StandardCollection.staticDocumentNameMatcher()	Returns the documentNameMatchSupplier if it exists.

Methods in org.apache.rat.config.exclusion that return types with arguments of type DocumentNameMatcher

Modifier and Type	Method	Description
Optional<DocumentNameMatcher>	MatcherSet.excludes()
Optional<DocumentNameMatcher>	MatcherSet.includes()

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

Modifier and Type	Method	Description
MatcherSet.Builder	MatcherSet.Builder.addExcluded(DocumentNameMatcher matcher)	Adds specified DocumentNameMatcher to the excluded matchers.
ExclusionProcessor	ExclusionProcessor.addExcludedMatcher(DocumentNameMatcher matcher)	Add the DocumentNameMatcher as an excluded pattern.
MatcherSet.Builder	MatcherSet.Builder.addIncluded(DocumentNameMatcher matcher)	Adds specified DocumentNameMatcher to the included matchers.
ExclusionProcessor	ExclusionProcessor.addIncludedMatcher(DocumentNameMatcher matcher)	Add a DocumentNameMatcher to the collection of file/directory patterns to ignore.
static FileFilter	ExclusionUtils.asFileFilter(DocumentName parent, DocumentNameMatcher nameMatcher)	Create a FileFilter from a PathMatcher.

Uses of DocumentNameMatcher in org.apache.rat.document

Fields in org.apache.rat.document declared as DocumentNameMatcher

Modifier and Type	Field	Description
static DocumentNameMatcher	DocumentNameMatcher.MATCHES_ALL	A matcher that matches all documents.
static DocumentNameMatcher	DocumentNameMatcher.MATCHES_NONE	A matcher that matches no documents.

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

Modifier and Type	Method	Description
static DocumentNameMatcher	DocumentNameMatcher.and(Collection<DocumentNameMatcher> matchers)	Performs a logical AND across the collection of matchers.
static DocumentNameMatcher	DocumentNameMatcher.and(DocumentNameMatcher... matchers)	Performs a logical AND across the collection of matchers.
static DocumentNameMatcher	DocumentNameMatcher.matcherSet(DocumentNameMatcher includes, DocumentNameMatcher excludes)	A particular matcher that will not match any excluded unless they are listed in the includes.
static DocumentNameMatcher	DocumentNameMatcher.not(DocumentNameMatcher nameMatcher)	Performs a logical NOT on a DocumentNameMatcher.
static DocumentNameMatcher	DocumentNameMatcher.or(Collection<DocumentNameMatcher> matchers)	Performs a logical OR across the collection of matchers.
static DocumentNameMatcher	DocumentNameMatcher.or(DocumentNameMatcher... matchers)	Performs a logical OR across the collection of matchers.

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

Modifier and Type	Method	Description
static DocumentNameMatcher	DocumentNameMatcher.and(DocumentNameMatcher... matchers)	Performs a logical AND across the collection of matchers.
static DocumentNameMatcher	DocumentNameMatcher.matcherSet(DocumentNameMatcher includes, DocumentNameMatcher excludes)	A particular matcher that will not match any excluded unless they are listed in the includes.
static DocumentNameMatcher	DocumentNameMatcher.not(DocumentNameMatcher nameMatcher)	Performs a logical NOT on a DocumentNameMatcher.
static DocumentNameMatcher	DocumentNameMatcher.or(DocumentNameMatcher... matchers)	Performs a logical OR across the collection of matchers.

Method parameters in org.apache.rat.document with type arguments of type DocumentNameMatcher

Modifier and Type	Method	Description
static DocumentNameMatcher	DocumentNameMatcher.and(Collection<DocumentNameMatcher> matchers)	Performs a logical AND across the collection of matchers.
static DocumentNameMatcher	DocumentNameMatcher.or(Collection<DocumentNameMatcher> matchers)	Performs a logical OR across the collection of matchers.

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

Modifier	Constructor	Description
	ArchiveEntryDocument(ArchiveEntryName entryName, byte[] contents, DocumentNameMatcher nameMatcher)	Creates an Archive entry.
	DocumentNameMatcher(String name, DocumentNameMatcher delegate)	Constructs a DocumentNameMatcher from a name and a delegate DocumentNameMatcher.
	FileDocument(File file, DocumentNameMatcher nameMatcher)	Creates a File document where the baseDir is the root directory.
	FileDocument(DocumentName basedir, File file, DocumentNameMatcher nameMatcher)	Creates a File document.
	IgnoredDocument(DocumentName basedir, File file, DocumentNameMatcher nameMatcher)	Creates a File document.