blob: dda453fd6df7530afee41d795dda3284434785e2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>PathFinder (Eclipse Jetty API Doc - v10.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PathFinder (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PathFinder.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.start</a></div>
<h2 title="Class PathFinder" class="title">Class PathFinder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.nio.file.SimpleFileVisitor&lt;java.nio.file.Path&gt;</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.start.PathFinder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.nio.file.FileVisitor&lt;java.nio.file.Path&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PathFinder</span>
extends java.nio.file.SimpleFileVisitor&lt;java.nio.file.Path&gt;</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">PathFinder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.nio.file.PathMatcher</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirMatcher()">getDirMatcher</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.nio.file.PathMatcher</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileMatcher()">getFileMatcher</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.io.File&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHitList()">getHitList</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;java.nio.file.Path&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHits()">getHits</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIncludeDirsInResults()">isIncludeDirsInResults</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.nio.file.FileVisitResult</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preVisitDirectory(java.nio.file.Path,java.nio.file.attribute.BasicFileAttributes)">preVisitDirectory</a></span>&#8203;(java.nio.file.Path&nbsp;dir,
java.nio.file.attribute.BasicFileAttributes&nbsp;attrs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBase(java.nio.file.Path)">setBase</a></span>&#8203;(java.nio.file.Path&nbsp;basePath)</code></th>
<td class="colLast">
<div class="block">Set the active basePath, used for resolving relative paths.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDirMatcher(java.nio.file.PathMatcher)">setDirMatcher</a></span>&#8203;(java.nio.file.PathMatcher&nbsp;dirMatcher)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFileMatcher(java.lang.String)">setFileMatcher</a></span>&#8203;(java.lang.String&nbsp;pattern)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFileMatcher(java.nio.file.PathMatcher)">setFileMatcher</a></span>&#8203;(java.nio.file.PathMatcher&nbsp;fileMatcher)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncludeDirsInResults(boolean)">setIncludeDirsInResults</a></span>&#8203;(boolean&nbsp;includeDirsInResults)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.nio.file.FileVisitResult</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visitFile(java.nio.file.Path,java.nio.file.attribute.BasicFileAttributes)">visitFile</a></span>&#8203;(java.nio.file.Path&nbsp;file,
java.nio.file.attribute.BasicFileAttributes&nbsp;attrs)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.nio.file.FileVisitResult</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visitFileFailed(java.nio.file.Path,java.io.IOException)">visitFileFailed</a></span>&#8203;(java.nio.file.Path&nbsp;file,
java.io.IOException&nbsp;exc)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.nio.file.SimpleFileVisitor">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.nio.file.SimpleFileVisitor</h3>
<code>postVisitDirectory</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PathFinder</h4>
<pre>public&nbsp;PathFinder()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getDirMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirMatcher</h4>
<pre class="methodSignature">public&nbsp;java.nio.file.PathMatcher&nbsp;getDirMatcher()</pre>
</li>
</ul>
<a id="getFileMatcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileMatcher</h4>
<pre class="methodSignature">public&nbsp;java.nio.file.PathMatcher&nbsp;getFileMatcher()</pre>
</li>
</ul>
<a id="getHitList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitList</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.io.File&gt;&nbsp;getHitList()</pre>
</li>
</ul>
<a id="getHits()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHits</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;java.nio.file.Path&gt;&nbsp;getHits()</pre>
</li>
</ul>
<a id="isIncludeDirsInResults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIncludeDirsInResults</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isIncludeDirsInResults()</pre>
</li>
</ul>
<a id="preVisitDirectory(java.nio.file.Path,java.nio.file.attribute.BasicFileAttributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preVisitDirectory</h4>
<pre class="methodSignature">public&nbsp;java.nio.file.FileVisitResult&nbsp;preVisitDirectory&#8203;(java.nio.file.Path&nbsp;dir,
java.nio.file.attribute.BasicFileAttributes&nbsp;attrs)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>preVisitDirectory</code>&nbsp;in interface&nbsp;<code>java.nio.file.FileVisitor&lt;java.nio.file.Path&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>preVisitDirectory</code>&nbsp;in class&nbsp;<code>java.nio.file.SimpleFileVisitor&lt;java.nio.file.Path&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="setBase(java.nio.file.Path)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBase</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBase&#8203;(java.nio.file.Path&nbsp;basePath)</pre>
<div class="block">Set the active basePath, used for resolving relative paths.
<p>
When a hit arrives for a subsequent find that has the same relative path as a prior hit, the new hit overrides the prior path as the active hit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>basePath</code> - the basePath to tag all hits with</dd>
</dl>
</li>
</ul>
<a id="setDirMatcher(java.nio.file.PathMatcher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDirMatcher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDirMatcher&#8203;(java.nio.file.PathMatcher&nbsp;dirMatcher)</pre>
</li>
</ul>
<a id="setFileMatcher(java.nio.file.PathMatcher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFileMatcher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFileMatcher&#8203;(java.nio.file.PathMatcher&nbsp;fileMatcher)</pre>
</li>
</ul>
<a id="setFileMatcher(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFileMatcher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFileMatcher&#8203;(java.lang.String&nbsp;pattern)</pre>
</li>
</ul>
<a id="setIncludeDirsInResults(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeDirsInResults</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIncludeDirsInResults&#8203;(boolean&nbsp;includeDirsInResults)</pre>
</li>
</ul>
<a id="visitFile(java.nio.file.Path,java.nio.file.attribute.BasicFileAttributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitFile</h4>
<pre class="methodSignature">public&nbsp;java.nio.file.FileVisitResult&nbsp;visitFile&#8203;(java.nio.file.Path&nbsp;file,
java.nio.file.attribute.BasicFileAttributes&nbsp;attrs)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>visitFile</code>&nbsp;in interface&nbsp;<code>java.nio.file.FileVisitor&lt;java.nio.file.Path&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>visitFile</code>&nbsp;in class&nbsp;<code>java.nio.file.SimpleFileVisitor&lt;java.nio.file.Path&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="visitFileFailed(java.nio.file.Path,java.io.IOException)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>visitFileFailed</h4>
<pre class="methodSignature">public&nbsp;java.nio.file.FileVisitResult&nbsp;visitFileFailed&#8203;(java.nio.file.Path&nbsp;file,
java.io.IOException&nbsp;exc)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>visitFileFailed</code>&nbsp;in interface&nbsp;<code>java.nio.file.FileVisitor&lt;java.nio.file.Path&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>visitFileFailed</code>&nbsp;in class&nbsp;<code>java.nio.file.SimpleFileVisitor&lt;java.nio.file.Path&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PathFinder.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>