Package org.apache.rat.config.exclusion

Interface MatcherSet

public interface MatcherSet

The file processor reads the file specified in the DocumentName. It must return a list of fully qualified strings for the MatchPattern to process. It may return either Ant or Regex style strings, or a mixture of both. See SelectorUtils for a description of the formats. It may also generate custom DocumentNameMatchers which are added to the customMatchers instance variable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MatcherSet.Builder	A MatcherSet that assumes the files contain the already formatted strings and just need to be localised for the fileName.

Method Summary

Modifier and Type	Method	Description
default DocumentNameMatcher	createMatcher()	Creates a DocumentNameMatcher from an iterable of matcher sets.
Optional<DocumentNameMatcher>	excludes()
default String	getDescription()
Optional<DocumentNameMatcher>	includes()
static MatcherSet	merge(List<MatcherSet> matcherSets)

Method Details

includes

Optional<DocumentNameMatcher> includes()

excludes

Optional<DocumentNameMatcher> excludes()

getDescription

default String getDescription()

createMatcher

default DocumentNameMatcher createMatcher()

Creates a DocumentNameMatcher from an iterable of matcher sets.

Returns:

A DocumentNameMatcher that processes the matcher sets.

merge

static MatcherSet merge(List<MatcherSet> matcherSets)