/usr/share/doc/libmaven-shared-utils-java/api/org/apache/maven/shared/utils/io/ScanConductor.html is in libmaven-shared-utils-java-doc 0.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | <!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 (version 1.7.0_85) on Sat Oct 24 01:27:16 UTC 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ScanConductor (Apache Maven Shared Utils 0.9 API)</title>
<meta name="date" content="2015-10-24">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScanConductor (Apache Maven Shared Utils 0.9 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ScanConductor.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/apache/maven/shared/utils/io/MatchPatterns.html" title="class in org.apache.maven.shared.utils.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/maven/shared/utils/io/ScanConductor.html" target="_top">Frames</a></li>
<li><a href="ScanConductor.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><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.apache.maven.shared.utils.io</div>
<h2 title="Interface ScanConductor" class="title">Interface ScanConductor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">ScanConductor</span></pre>
<div class="block"><p>Visitor pattern for the DirectoryScanner. A ScanConductor controls the scanning process.</p>
<p/>
<p>Create an instance and pass it to
<a href="../../../../../../org/apache/maven/shared/utils/io/DirectoryScanner.html#setScanConductor(org.apache.maven.shared.utils.io.ScanConductor)"><code>DirectoryScanner.setScanConductor(ScanConductor)</code></a>.
You will get notified about every visited directory and file. You can use the <a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io"><code>ScanConductor.ScanAction</code></a>
to control what should happen next.</p>
<p/>
<p>A ScanConductor might also store own information but users must make sure that the state gets
cleaned between two scan() invocations.</p></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:struberg@apache.org">Mark Struberg</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io">ScanConductor.ScanAction</a></strong></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io">ScanConductor.ScanAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.html#visitDirectory(java.lang.String,%20java.io.File)">visitDirectory</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory)</code>
<div class="block">This method will get invoked for every detected directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io">ScanConductor.ScanAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.html#visitFile(java.lang.String,%20java.io.File)">visitFile</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code>
<div class="block">This method will get invoked for every detected file.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="visitDirectory(java.lang.String, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitDirectory</h4>
<pre><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io">ScanConductor.ScanAction</a> visitDirectory(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory)</pre>
<div class="block">This method will get invoked for every detected directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the directory name (contains parent folders up to the pwd)</dd><dd><code>directory</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the ScanAction to control how to proceed with the scanning</dd></dl>
</li>
</ul>
<a name="visitFile(java.lang.String, java.io.File)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>visitFile</h4>
<pre><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io">ScanConductor.ScanAction</a> visitFile(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre>
<div class="block">This method will get invoked for every detected file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the file name (contains parent folders up to the pwd)</dd><dd><code>file</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the ScanAction to control how to proceed with the scanning</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ScanConductor.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/apache/maven/shared/utils/io/MatchPatterns.html" title="class in org.apache.maven.shared.utils.io"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/maven/shared/utils/io/ScanConductor.ScanAction.html" title="enum in org.apache.maven.shared.utils.io"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/maven/shared/utils/io/ScanConductor.html" target="_top">Frames</a></li>
<li><a href="ScanConductor.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><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 © 2015. All rights reserved.</small></p>
</body>
</html>
|