| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:26 EDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PathWatcher.Config (Jetty :: Project 9.3.24.v20180605 API)</title> |
| <meta name="date" content="2018-06-07"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PathWatcher.Config (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PathWatcher.Config.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"> |
| <li><a href="../../../../org/eclipse/jetty/util/PathWatcher.html" title="class in org.eclipse.jetty.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/util/PathWatcher.DepthLimitedFileVisitor.html" title="class in org.eclipse.jetty.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/util/PathWatcher.Config.html" target="_top">Frames</a></li> |
| <li><a href="PathWatcher.Config.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <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> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.jetty.util</div> |
| <h2 title="Class PathWatcher.Config" class="title">Class PathWatcher.Config</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.util.PathWatcher.Config</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../org/eclipse/jetty/util/PathWatcher.html" title="class in org.eclipse.jetty.util">PathWatcher</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">PathWatcher.Config</span> |
| extends java.lang.Object</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.nio.file.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#dir">dir</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#excludeHidden">excludeHidden</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<java.nio.file.PathMatcher></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#excludes">excludes</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.List<java.nio.file.PathMatcher></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#includes">includes</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#recurseDepth">recurseDepth</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#UNLIMITED_DEPTH">UNLIMITED_DEPTH</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#Config-java.nio.file.Path-">Config</a></span>(java.nio.file.Path path)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addExclude-java.nio.file.PathMatcher-">addExclude</a></span>(java.nio.file.PathMatcher matcher)</code> |
| <div class="block">Add an exclude PathMatcher</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addExclude-java.lang.String-">addExclude</a></span>(java.lang.String syntaxAndPattern)</code> |
| <div class="block">Add an exclude PathMatcher.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addExcludeGlobRelative-java.lang.String-">addExcludeGlobRelative</a></span>(java.lang.String pattern)</code> |
| <div class="block">Add a <code>glob:</code> syntax pattern exclude reference in a directory relative, os neutral, pattern.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addExcludeHidden--">addExcludeHidden</a></span>()</code> |
| <div class="block">Exclude hidden files and hidden directories</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addExcludes-java.util.List-">addExcludes</a></span>(java.util.List<java.lang.String> syntaxAndPatterns)</code> |
| <div class="block">Add multiple exclude PathMatchers</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addInclude-java.nio.file.PathMatcher-">addInclude</a></span>(java.nio.file.PathMatcher matcher)</code> |
| <div class="block">Add an include PathMatcher</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addInclude-java.lang.String-">addInclude</a></span>(java.lang.String syntaxAndPattern)</code> |
| <div class="block">Add an include PathMatcher</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addIncludeGlobRelative-java.lang.String-">addIncludeGlobRelative</a></span>(java.lang.String pattern)</code> |
| <div class="block">Add a <code>glob:</code> syntax pattern reference in a directory relative, os neutral, pattern.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#addIncludes-java.util.List-">addIncludes</a></span>(java.util.List<java.lang.String> syntaxAndPatterns)</code> |
| <div class="block">Add multiple include PathMatchers</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html" title="class in org.eclipse.jetty.util">PathWatcher.Config</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#asSubConfig-java.nio.file.Path-">asSubConfig</a></span>(java.nio.file.Path dir)</code> |
| <div class="block">Build a new config from a this configuration.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.nio.file.Path</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#getPath--">getPath</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#getRecurseDepth--">getRecurseDepth</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#isExcluded-java.nio.file.Path-">isExcluded</a></span>(java.nio.file.Path dir)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#isIncluded-java.nio.file.Path-">isIncluded</a></span>(java.nio.file.Path dir)</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#isRecurseDepthUnlimited--">isRecurseDepthUnlimited</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#matches-java.nio.file.Path-">matches</a></span>(java.nio.file.Path path)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#setRecurseDepth-int-">setRecurseDepth</a></span>(int depth)</code> |
| <div class="block">Set the recurse depth for the directory scanning.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#shouldRecurseDirectory-java.nio.file.Path-">shouldRecurseDirectory</a></span>(java.nio.file.Path child)</code> |
| <div class="block">Determine if the provided child directory should be recursed into based on the configured <a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#setRecurseDepth-int-"><code>setRecurseDepth(int)</code></a></div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="UNLIMITED_DEPTH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNLIMITED_DEPTH</h4> |
| <pre>public static final int UNLIMITED_DEPTH</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.jetty.util.PathWatcher.Config.UNLIMITED_DEPTH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dir"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dir</h4> |
| <pre>protected final java.nio.file.Path dir</pre> |
| </li> |
| </ul> |
| <a name="recurseDepth"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recurseDepth</h4> |
| <pre>protected int recurseDepth</pre> |
| </li> |
| </ul> |
| <a name="includes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>includes</h4> |
| <pre>protected java.util.List<java.nio.file.PathMatcher> includes</pre> |
| </li> |
| </ul> |
| <a name="excludes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>excludes</h4> |
| <pre>protected java.util.List<java.nio.file.PathMatcher> excludes</pre> |
| </li> |
| </ul> |
| <a name="excludeHidden"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>excludeHidden</h4> |
| <pre>protected boolean excludeHidden</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Config-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Config</h4> |
| <pre>public Config(java.nio.file.Path path)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addExclude-java.nio.file.PathMatcher-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExclude</h4> |
| <pre>public void addExclude(java.nio.file.PathMatcher matcher)</pre> |
| <div class="block">Add an exclude PathMatcher</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>matcher</code> - the path matcher for this exclude</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExclude-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExclude</h4> |
| <pre>public void addExclude(java.lang.String syntaxAndPattern)</pre> |
| <div class="block">Add an exclude PathMatcher. |
| <p> |
| Note: this pattern is FileSystem specific (so use "/" for Linux and OSX, and "\\" for Windows)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>syntaxAndPattern</code> - the PathMatcher syntax and pattern to use</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>for detail on syntax and pattern</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExcludeGlobRelative-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludeGlobRelative</h4> |
| <pre>public void addExcludeGlobRelative(java.lang.String pattern)</pre> |
| <div class="block">Add a <code>glob:</code> syntax pattern exclude reference in a directory relative, os neutral, pattern. |
| |
| <pre> |
| On Linux: |
| Config config = new Config(Path("/home/user/example")); |
| config.addExcludeGlobRelative("*.war") => "glob:/home/user/example/*.war" |
| |
| On Windows |
| Config config = new Config(Path("D:/code/examples")); |
| config.addExcludeGlobRelative("*.war") => "glob:D:\\code\\examples\\*.war" |
| |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the pattern, in unixy format, relative to config.dir</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addExcludeHidden--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludeHidden</h4> |
| <pre>public void addExcludeHidden()</pre> |
| <div class="block">Exclude hidden files and hidden directories</div> |
| </li> |
| </ul> |
| <a name="addExcludes-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExcludes</h4> |
| <pre>public void addExcludes(java.util.List<java.lang.String> syntaxAndPatterns)</pre> |
| <div class="block">Add multiple exclude PathMatchers</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>syntaxAndPatterns</code> - the list of PathMatcher syntax and patterns to use</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>for detail on syntax and pattern</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addInclude-java.nio.file.PathMatcher-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addInclude</h4> |
| <pre>public void addInclude(java.nio.file.PathMatcher matcher)</pre> |
| <div class="block">Add an include PathMatcher</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>matcher</code> - the path matcher for this include</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addInclude-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addInclude</h4> |
| <pre>public void addInclude(java.lang.String syntaxAndPattern)</pre> |
| <div class="block">Add an include PathMatcher</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>syntaxAndPattern</code> - the PathMatcher syntax and pattern to use</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>for detail on syntax and pattern</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addIncludeGlobRelative-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncludeGlobRelative</h4> |
| <pre>public void addIncludeGlobRelative(java.lang.String pattern)</pre> |
| <div class="block">Add a <code>glob:</code> syntax pattern reference in a directory relative, os neutral, pattern. |
| |
| <pre> |
| On Linux: |
| Config config = new Config(Path("/home/user/example")); |
| config.addIncludeGlobRelative("*.war") => "glob:/home/user/example/*.war" |
| |
| On Windows |
| Config config = new Config(Path("D:/code/examples")); |
| config.addIncludeGlobRelative("*.war") => "glob:D:\\code\\examples\\*.war" |
| |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the pattern, in unixy format, relative to config.dir</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addIncludes-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIncludes</h4> |
| <pre>public void addIncludes(java.util.List<java.lang.String> syntaxAndPatterns)</pre> |
| <div class="block">Add multiple include PathMatchers</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>syntaxAndPatterns</code> - the list of PathMatcher syntax and patterns to use</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>for detail on syntax and pattern</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="asSubConfig-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asSubConfig</h4> |
| <pre>public <a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html" title="class in org.eclipse.jetty.util">PathWatcher.Config</a> asSubConfig(java.nio.file.Path dir)</pre> |
| <div class="block">Build a new config from a this configuration. |
| <p> |
| Useful for working with sub-directories that also need to be watched.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dir</code> - the directory to build new Config from (using this config as source of includes/excludes)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new Config</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRecurseDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRecurseDepth</h4> |
| <pre>public int getRecurseDepth()</pre> |
| </li> |
| </ul> |
| <a name="isRecurseDepthUnlimited--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRecurseDepthUnlimited</h4> |
| <pre>public boolean isRecurseDepthUnlimited()</pre> |
| </li> |
| </ul> |
| <a name="getPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPath</h4> |
| <pre>public java.nio.file.Path getPath()</pre> |
| </li> |
| </ul> |
| <a name="isExcluded-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExcluded</h4> |
| <pre>public boolean isExcluded(java.nio.file.Path dir) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIncluded-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIncluded</h4> |
| <pre>public boolean isIncluded(java.nio.file.Path dir)</pre> |
| </li> |
| </ul> |
| <a name="matches-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matches</h4> |
| <pre>public boolean matches(java.nio.file.Path path)</pre> |
| </li> |
| </ul> |
| <a name="setRecurseDepth-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRecurseDepth</h4> |
| <pre>public void setRecurseDepth(int depth)</pre> |
| <div class="block">Set the recurse depth for the directory scanning. |
| <p> |
| -999 indicates arbitrarily deep recursion, 0 indicates no recursion, 1 is only one directory deep, and so on.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>depth</code> - the number of directories deep to recurse</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldRecurseDirectory-java.nio.file.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldRecurseDirectory</h4> |
| <pre>public boolean shouldRecurseDirectory(java.nio.file.Path child)</pre> |
| <div class="block">Determine if the provided child directory should be recursed into based on the configured <a href="../../../../org/eclipse/jetty/util/PathWatcher.Config.html#setRecurseDepth-int-"><code>setRecurseDepth(int)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>child</code> - the child directory to test against</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if recurse should occur, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PathWatcher.Config.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"> |
| <li><a href="../../../../org/eclipse/jetty/util/PathWatcher.html" title="class in org.eclipse.jetty.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/jetty/util/PathWatcher.DepthLimitedFileVisitor.html" title="class in org.eclipse.jetty.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/jetty/util/PathWatcher.Config.html" target="_top">Frames</a></li> |
| <li><a href="PathWatcher.Config.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <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> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1995–2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
