rat017/apidocs/org/apache/rat/document/DocumentNameMatcher.html - creadur-site - Git at Google

 <!DOCTYPE HTML>
 <html lang>
 <head>
 <!-- Generated by javadoc (21) -->
 <title>DocumentNameMatcher (Apache Creadur RAT 0.17-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.rat.document, class: DocumentNameMatcher">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/DocumentNameMatcher.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li><a href="#nested-class-summary">Nested</a></li>
 <li><a href="#field-summary">Field</a></li>
 <li><a href="#constructor-summary">Constr</a></li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li><a href="#field-detail">Field</a></li>
 <li><a href="#constructor-detail">Constr</a></li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.rat.document</a></div>
 <h1 title="Class DocumentNameMatcher" class="title">Class DocumentNameMatcher</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.rat.document.DocumentNameMatcher</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">DocumentNameMatcher</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">Matches document names.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="caption"><span>Nested Classes</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final class&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="DocumentNameMatcher.DecomposeData.html" class="type-name-link" title="class in org.apache.rat.document">DocumentNameMatcher.DecomposeData</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Data from a <a href="#decompose(org.apache.rat.document.DocumentName)"><code>decompose(DocumentName)</code></a> call.</div>
 </div>
 <div class="col-first odd-row-color"><code>static final class&nbsp;</code></div>
 <div class="col-second odd-row-color"><code><a href="DocumentNameMatcher.FileFilterPredicate.html" class="type-name-link" title="class in org.apache.rat.document">DocumentNameMatcher.FileFilterPredicate</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">A DocumentName predicate that uses <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link"><code>FileFilter</code></a>.</div>
 </div>
 <div class="col-first even-row-color"><code>static final class&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="DocumentNameMatcher.MatchPatternsPredicate.html" class="type-name-link" title="class in org.apache.rat.document">DocumentNameMatcher.MatchPatternsPredicate</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A DocumentName predicate that uses <a href="../config/exclusion/plexus/MatchPatterns.html" title="class in org.apache.rat.config.exclusion.plexus"><code>MatchPatterns</code></a>.</div>
 </div>
 <div class="col-first odd-row-color"><code>static final class&nbsp;</code></div>
 <div class="col-second odd-row-color"><code><a href="DocumentNameMatcher.NotPredicate.html" class="type-name-link" title="class in org.apache.rat.document">DocumentNameMatcher.NotPredicate</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">A DocumentName predicate that reverses another DocumentNameMatcher.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second even-row-color"><code><a href="#MATCHES_ALL" class="member-name-link">MATCHES_ALL</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A matcher that matches all documents.</div>
 </div>
 <div class="col-first odd-row-color"><code>static final <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#MATCHES_NONE" class="member-name-link">MATCHES_NONE</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">A matcher that matches no documents.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.FileFilter)" class="member-name-link">DocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a DocumentNameMatcher from a File filter.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.io.FileFilter)" class="member-name-link">DocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Creates a DocumentNameMatcher from a File filter.</div>
 </div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.function.Predicate)" class="member-name-link">DocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&gt;&nbsp;predicate)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Constructs a DocumentNameMatcher from a name and a DocumentName predicate.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.rat.config.exclusion.plexus.MatchPatterns)" class="member-name-link">DocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="../config/exclusion/plexus/MatchPatterns.html" title="class in org.apache.rat.config.exclusion.plexus">MatchPatterns</a>&nbsp;matchers)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Constructs a DocumentNameMatcher from a name and a MatcherPatterns object.</div>
 </div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.rat.config.exclusion.plexus.MatchPatterns,org.apache.rat.document.DocumentName)" class="member-name-link">DocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="../config/exclusion/plexus/MatchPatterns.html" title="class in org.apache.rat.config.exclusion.plexus">MatchPatterns</a>&nbsp;patterns,
  <a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;basedir)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Constructs a DocumentNameMatcher from a name a MatchPatterns instance and the DocumentName for the base name.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.rat.document.DocumentNameMatcher)" class="member-name-link">DocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;delegate)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Constructs a DocumentNameMatcher from a name and a delegate DocumentNameMatcher.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#and(java.util.Collection)" class="member-name-link">and</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&gt;&nbsp;matchers)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Performs a logical <code>AND</code> across the collection of matchers.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#and(org.apache.rat.document.DocumentNameMatcher...)" class="member-name-link">and</a><wbr>(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>...&nbsp;matchers)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Performs a logical <code>AND</code> across the collection of matchers.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><wbr>&lt;<a href="DocumentNameMatcher.DecomposeData.html" title="class in org.apache.rat.document">DocumentNameMatcher.DecomposeData</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#decompose(org.apache.rat.document.DocumentName)" class="member-name-link">decompose</a><wbr>(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;candidate)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Decomposes the matcher execution against the candidate.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><wbr>&lt;<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPredicate()" class="member-name-link">getPredicate</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the predicate that this DocumentNameMatcher is using.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCollection()" class="member-name-link">isCollection</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logDecompositionWhileMatching(org.apache.rat.document.DocumentName)" class="member-name-link">logDecompositionWhileMatching</a><wbr>(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;candidate)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Calculates the match result and logs the calculations.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#matcherSet(org.apache.rat.document.DocumentNameMatcher,org.apache.rat.document.DocumentNameMatcher)" class="member-name-link">matcherSet</a><wbr>(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;includes,
  <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;excludes)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">A particular matcher that will not match any excluded unless they are listed in the includes.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matches(org.apache.rat.document.DocumentName)" class="member-name-link">matches</a><wbr>(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;documentName)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Performs the match against the DocumentName.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#not(org.apache.rat.document.DocumentNameMatcher)" class="member-name-link">not</a><wbr>(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;nameMatcher)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Performs a logical <code>NOT</code> on a DocumentNameMatcher.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#or(java.util.Collection)" class="member-name-link">or</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&gt;&nbsp;matchers)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Performs a logical <code>OR</code> across the collection of matchers.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#or(org.apache.rat.document.DocumentNameMatcher...)" class="member-name-link">or</a><wbr>(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>...&nbsp;matchers)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Performs a logical <code>OR</code> across the collection of matchers.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="MATCHES_ALL">
 <h3>MATCHES_ALL</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">MATCHES_ALL</span></div>
 <div class="block">A matcher that matches all documents.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="MATCHES_NONE">
 <h3>MATCHES_NONE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">MATCHES_NONE</span></div>
 <div class="block">A matcher that matches no documents.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,java.util.function.Predicate)">
 <h3>DocumentNameMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&gt;&nbsp;predicate)</span></div>
 <div class="block">Constructs a DocumentNameMatcher from a name and a DocumentName predicate.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the name for this matcher.</dd>
 <dd><code>predicate</code> - the predicate to determine matches.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.rat.document.DocumentNameMatcher)">
 <h3>DocumentNameMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;delegate)</span></div>
 <div class="block">Constructs a DocumentNameMatcher from a name and a delegate DocumentNameMatcher.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the name for this matcher.</dd>
 <dd><code>delegate</code> - the delegate to defer to.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.rat.config.exclusion.plexus.MatchPatterns,org.apache.rat.document.DocumentName)">
 <h3>DocumentNameMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="../config/exclusion/plexus/MatchPatterns.html" title="class in org.apache.rat.config.exclusion.plexus">MatchPatterns</a>&nbsp;patterns,
  <a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;basedir)</span></div>
 <div class="block">Constructs a DocumentNameMatcher from a name a MatchPatterns instance and the DocumentName for the base name.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the name of this matcher.</dd>
 <dd><code>patterns</code> - the patterns in the matcher.</dd>
 <dd><code>basedir</code> - the base directory for the scanning.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.rat.config.exclusion.plexus.MatchPatterns)">
 <h3>DocumentNameMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="../config/exclusion/plexus/MatchPatterns.html" title="class in org.apache.rat.config.exclusion.plexus">MatchPatterns</a>&nbsp;matchers)</span></div>
 <div class="block">Constructs a DocumentNameMatcher from a name and a MatcherPatterns object.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the name of the matcher.</dd>
 <dd><code>matchers</code> - fully specified matchers.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,java.io.FileFilter)">
 <h3>DocumentNameMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
  <a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</span></div>
 <div class="block">Creates a DocumentNameMatcher from a File filter.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - The name of this matcher.</dd>
 <dd><code>fileFilter</code> - the file filter to execute.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.io.FileFilter)">
 <h3>DocumentNameMatcher</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</span></div>
 <div class="block">Creates a DocumentNameMatcher from a File filter.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>fileFilter</code> - the file filter to execute.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="isCollection()">
 <h3>isCollection</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isCollection</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getPredicate()">
 <h3>getPredicate</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&gt;</span>&nbsp;<span class="element-name">getPredicate</span>()</div>
 <div class="block">Returns the predicate that this DocumentNameMatcher is using.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>The predicate that this DocumentNameMatcher is using.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="logDecompositionWhileMatching(org.apache.rat.document.DocumentName)">
 <h3>logDecompositionWhileMatching</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">logDecompositionWhileMatching</span><wbr><span class="parameters">(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;candidate)</span></div>
 <div class="block">Calculates the match result and logs the calculations.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>candidate</code> - the candidate to evaluate the match for.</dd>
 <dt>Returns:</dt>
 <dd>the result of the calculation</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="decompose(org.apache.rat.document.DocumentName)">
 <h3>decompose</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="DocumentNameMatcher.DecomposeData.html" title="class in org.apache.rat.document">DocumentNameMatcher.DecomposeData</a>&gt;</span>&nbsp;<span class="element-name">decompose</span><wbr><span class="parameters">(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;candidate)</span></div>
 <div class="block">Decomposes the matcher execution against the candidate.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>candidate</code> - the candidate to check.</dd>
 <dt>Returns:</dt>
 <dd>a list of <a href="DocumentNameMatcher.DecomposeData.html" title="class in org.apache.rat.document"><code>DocumentNameMatcher.DecomposeData</code></a> for each evaluation in the matcher.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="matches(org.apache.rat.document.DocumentName)">
 <h3>matches</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">matches</span><wbr><span class="parameters">(<a href="DocumentName.html" title="class in org.apache.rat.document">DocumentName</a>&nbsp;documentName)</span></div>
 <div class="block">Performs the match against the DocumentName.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>documentName</code> - the document name to check.</dd>
 <dt>Returns:</dt>
 <dd>true if the documentName matchers this DocumentNameMatcher.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="not(org.apache.rat.document.DocumentNameMatcher)">
 <h3>not</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">not</span><wbr><span class="parameters">(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;nameMatcher)</span></div>
 <div class="block">Performs a logical <code>NOT</code> on a DocumentNameMatcher.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>nameMatcher</code> - the matcher to negate.</dd>
 <dt>Returns:</dt>
 <dd>a PathMatcher that is the negation of the argument.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="or(java.util.Collection)">
 <h3>or</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">or</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&gt;&nbsp;matchers)</span></div>
 <div class="block">Performs a logical <code>OR</code> across the collection of matchers.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>matchers</code> - the matchers to check.</dd>
 <dt>Returns:</dt>
 <dd>a matcher that returns <code>true</code> if any of the enclosed matchers returns <code>true</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="or(org.apache.rat.document.DocumentNameMatcher...)">
 <h3>or</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">or</span><wbr><span class="parameters">(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>...&nbsp;matchers)</span></div>
 <div class="block">Performs a logical <code>OR</code> across the collection of matchers.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>matchers</code> - the matchers to check.</dd>
 <dt>Returns:</dt>
 <dd>a matcher that returns <code>true</code> if any of the enclosed matchers returns <code>true</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="and(java.util.Collection)">
 <h3>and</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">and</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&gt;&nbsp;matchers)</span></div>
 <div class="block">Performs a logical <code>AND</code> across the collection of matchers.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>matchers</code> - the matchers to check.</dd>
 <dt>Returns:</dt>
 <dd>a matcher that returns <code>true</code> if all the enclosed matchers return <code>true</code>.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="matcherSet(org.apache.rat.document.DocumentNameMatcher,org.apache.rat.document.DocumentNameMatcher)">
 <h3>matcherSet</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">matcherSet</span><wbr><span class="parameters">(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;includes,
  <a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;excludes)</span></div>
 <div class="block">A particular matcher that will not match any excluded unless they are listed in the includes.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>includes</code> - the DocumentNameMatcher to match the includes.</dd>
 <dd><code>excludes</code> - the DocumentNameMatcher to match the excludes.</dd>
 <dt>Returns:</dt>
 <dd>a DocumentNameMatcher with the specified logic.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="and(org.apache.rat.document.DocumentNameMatcher...)">
 <h3>and</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a></span>&nbsp;<span class="element-name">and</span><wbr><span class="parameters">(<a href="DocumentNameMatcher.html" title="class in org.apache.rat.document">DocumentNameMatcher</a>...&nbsp;matchers)</span></div>
 <div class="block">Performs a logical <code>AND</code> across the collection of matchers.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>matchers</code> - the matchers to check.</dd>
 <dt>Returns:</dt>
 <dd>a matcher that returns <code>true</code> if all the enclosed matchers return <code>true</code>.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2006&#x2013;2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>