blob: 9d9700a51c8cd742e813abef100c7bf89521f0e8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (21) -->
<title>TraceableDocumentNameMatcher (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: TraceableDocumentNameMatcher">
<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.6.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/TraceableDocumentNameMatcher.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>Nested</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>Nested&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 TraceableDocumentNameMatcher" class="title">Class TraceableDocumentNameMatcher</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.TraceableDocumentNameMatcher</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TraceableDocumentNameMatcher</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>
implements <a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a></span></div>
<div class="block">A PatternMatcher that will emit trace messages during execution if the environment variable is set.
Also provides a printable name for general logging.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== 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="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 even-row-color"><code><a href="#ENV_VAR" class="member-name-link">ENV_VAR</a></code></div>
<div class="col-last even-row-color">
<div class="block">The environment variable to set to enable tracing for the PatternMatcher execution</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></code></div>
<div class="col-second odd-row-color"><code><a href="#FALSE" class="member-name-link">FALSE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">A TraceableDocumentNameMatcher that always returns <code>false</code></div>
</div>
<div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><wbr>&lt;<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>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
<div class="col-last even-row-color">
<div class="block">The supplier for the name</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></code></div>
<div class="col-second odd-row-color"><code><a href="#TRUE" class="member-name-link">TRUE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">A TraceableDocumentNameMatcher that always returns <code>true</code></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 three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.function.Supplier,org.apache.rat.document.DocumentNameMatcher)" class="member-name-link">TraceableDocumentNameMatcher</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<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>&gt;&nbsp;name,
<a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;delegate)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a traceable pattern matcher with the specified name.</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" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<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="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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(org.apache.rat.document.TraceableDocumentNameMatcher...)" class="member-name-link">and</a><wbr>(<a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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 "AND" 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="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#from(java.io.FileFilter)" class="member-name-link">from</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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#make(java.util.function.Supplier,org.apache.rat.document.DocumentNameMatcher)" class="member-name-link">make</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<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>&gt;&nbsp;name,
<a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;delegate)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Creates a TraceableDocumentNameMatcher from a PathMatcher.</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">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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.TraceableDocumentNameMatcher)" class="member-name-link">not</a><wbr>(<a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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 "not" on a nameMatcher.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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 "OR" 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="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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.TraceableDocumentNameMatcher...)" class="member-name-link">or</a><wbr>(<a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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 "OR" 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="ENV_VAR">
<h3>ENV_VAR</h3>
<div class="member-signature"><span class="modifiers">public static final</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">ENV_VAR</span></div>
<div class="block">The environment variable to set to enable tracing for the PatternMatcher execution</div>
</section>
</li>
<li>
<section class="detail" id="name">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">name</span></div>
<div class="block">The supplier for the name</div>
</section>
</li>
<li>
<section class="detail" id="TRUE">
<h3>TRUE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">TRUE</span></div>
<div class="block">A TraceableDocumentNameMatcher that always returns <code>true</code></div>
</section>
</li>
<li>
<section class="detail" id="FALSE">
<h3>FALSE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">FALSE</span></div>
<div class="block">A TraceableDocumentNameMatcher that always returns <code>false</code></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.util.function.Supplier,org.apache.rat.document.DocumentNameMatcher)">
<h3>TraceableDocumentNameMatcher</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">TraceableDocumentNameMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<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>&gt;&nbsp;name,
<a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;delegate)</span></div>
<div class="block">Creates a traceable pattern matcher with the specified name.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the pattern matcher.</dd>
<dd><code>delegate</code> - the delegate that actually does the work.</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="make(java.util.function.Supplier,org.apache.rat.document.DocumentNameMatcher)">
<h3>make</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">make</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<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>&gt;&nbsp;name,
<a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a>&nbsp;delegate)</span></div>
<div class="block">Creates a TraceableDocumentNameMatcher from a PathMatcher.
If the <code>delegate</code> is already a TraceableDocumentNameMatcher it will be returned unmodified.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the traceable path matcher.</dd>
<dd><code>delegate</code> - the PathMatcher that will actually do the work.</dd>
<dt>Returns:</dt>
<dd>the new TraceableDocumentNameMatcher</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="from(java.io.FileFilter)">
<h3>from</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">from</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>
</section>
</li>
<li>
<section class="detail" id="not(org.apache.rat.document.TraceableDocumentNameMatcher)">
<h3>not</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">not</span><wbr><span class="parameters">(<a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a>&nbsp;nameMatcher)</span></div>
<div class="block">Performs a logical "not" on a nameMatcher.</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="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</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="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a>&gt;&nbsp;matchers)</span></div>
<div class="block">Performs a logical "OR" 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 TRUE if any of the enclosed matchers returns true.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="or(org.apache.rat.document.TraceableDocumentNameMatcher...)">
<h3>or</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">or</span><wbr><span class="parameters">(<a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a>...&nbsp;matchers)</span></div>
<div class="block">Performs a logical "OR" 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 TRUE if any of the enclosed matchers returns true.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="and(org.apache.rat.document.TraceableDocumentNameMatcher...)">
<h3>and</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a></span>&nbsp;<span class="element-name">and</span><wbr><span class="parameters">(<a href="TraceableDocumentNameMatcher.html" title="class in org.apache.rat.document">TraceableDocumentNameMatcher</a>...&nbsp;matchers)</span></div>
<div class="block">Performs a logical "AND" 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 TRUE if all the enclosed matchers return true.</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="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>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="DocumentNameMatcher.html#matches(org.apache.rat.document.DocumentName)">matches</a></code>&nbsp;in interface&nbsp;<code><a href="DocumentNameMatcher.html" title="interface in org.apache.rat.document">DocumentNameMatcher</a></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;2024 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>