juplo.de Git - website/blob - dist/scannotation-1.0.4/apidocs/org/scannotation/archiveiterator/FileIterator.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="de">
   4 <head>
   5 <!-- Generated by javadoc (version 1.7.0_79) on Tue May 12 22:00:47 CEST 2015 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
   7 <title>FileIterator (scannotation 1.0.4 API)</title>
   8 <meta name="date" content="2015-05-12">
   9 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="FileIterator (scannotation 1.0.4 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../overview-summary.html">Overview</a></li>
  29 <li><a href="package-summary.html">Package</a></li>
  30 <li class="navBarCell1Rev">Class</li>
  31 <li><a href="class-use/FileIterator.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../index-all.html">Index</a></li>
  35 <li><a href="../../../help-doc.html">Help</a></li>
  36 </ul>
  37 </div>
  38 <div class="subNav">
  39 <ul class="navList">
  40 <li><a href="../../../org/scannotation/archiveiterator/DirectoryIteratorFactory.html" title="interface in org.scannotation.archiveiterator"><span class="strong">Prev Class</span></a></li>
  41 <li><a href="../../../org/scannotation/archiveiterator/FileProtocolIteratorFactory.html" title="class in org.scannotation.archiveiterator"><span class="strong">Next Class</span></a></li>
  42 </ul>
  43 <ul class="navList">
  44 <li><a href="../../../index.html?org/scannotation/archiveiterator/FileIterator.html" target="_top">Frames</a></li>
  45 <li><a href="FileIterator.html" target="_top">No Frames</a></li>
  46 </ul>
  47 <ul class="navList" id="allclasses_navbar_top">
  48 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
  49 </ul>
  50 <div>
  51 <script type="text/javascript"><!--
  52   allClassesLink = document.getElementById("allclasses_navbar_top");
  53   if(window==top) {
  54     allClassesLink.style.display = "block";
  55   }
  56   else {
  57     allClassesLink.style.display = "none";
  58   }
  59   //-->
  60 </script>
  61 </div>
  62 <div>
  63 <ul class="subNavList">
  64 <li>Summary:&nbsp;</li>
  65 <li>Nested&nbsp;|&nbsp;</li>
  66 <li>Field&nbsp;|&nbsp;</li>
  67 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  68 <li><a href="#method_summary">Method</a></li>
  69 </ul>
  70 <ul class="subNavList">
  71 <li>Detail:&nbsp;</li>
  72 <li>Field&nbsp;|&nbsp;</li>
  73 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  74 <li><a href="#method_detail">Method</a></li>
  75 </ul>
  76 </div>
  77 <a name="skip-navbar_top">
  78 <!--   -->
  79 </a></div>
  80 <!-- ========= END OF TOP NAVBAR ========= -->
  81 <!-- ======== START OF CLASS DATA ======== -->
  82 <div class="header">
  83 <div class="subTitle">org.scannotation.archiveiterator</div>
  84 <h2 title="Class FileIterator" class="title">Class FileIterator</h2>
  85 </div>
  86 <div class="contentContainer">
  87 <ul class="inheritance">
  88 <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  89 <li>
  90 <ul class="inheritance">
  91 <li>org.scannotation.archiveiterator.FileIterator</li>
  92 </ul>
  93 </li>
  94 </ul>
  95 <div class="description">
  96 <ul class="blockList">
  97 <li class="blockList">
  98 <dl>
  99 <dt>All Implemented Interfaces:</dt>
 100 <dd><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></dd>
 101 </dl>
 102 <hr>
 103 <br>
 104 <pre>public class <span class="strong">FileIterator</span>
 105 extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
 106 implements <a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></pre>
 107 <dl><dt><span class="strong">Version:</span></dt>
 108   <dd>$Revision: 1 $</dd>
 109 <dt><span class="strong">Author:</span></dt>
 110   <dd><a href="mailto:bill@burkecentral.com">Bill Burke</a></dd></dl>
 111 </li>
 112 </ul>
 113 </div>
 114 <div class="summary">
 115 <ul class="blockList">
 116 <li class="blockList">
 117 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 118 <ul class="blockList">
 119 <li class="blockList"><a name="constructor_summary">
 120 <!--   -->
 121 </a>
 122 <h3>Constructor Summary</h3>
 123 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 124 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 125 <tr>
 126 <th class="colOne" scope="col">Constructor and Description</th>
 127 </tr>
 128 <tr class="altColor">
 129 <td class="colOne"><code><strong><a href="../../../org/scannotation/archiveiterator/FileIterator.html#FileIterator(java.io.File,%20org.scannotation.archiveiterator.Filter)">FileIterator</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
 130             <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a>&nbsp;filter)</code>&nbsp;</td>
 131 </tr>
 132 </table>
 133 </li>
 134 </ul>
 135 <!-- ========== METHOD SUMMARY =========== -->
 136 <ul class="blockList">
 137 <li class="blockList"><a name="method_summary">
 138 <!--   -->
 139 </a>
 140 <h3>Method Summary</h3>
 141 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 142 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
 143 <tr>
 144 <th class="colFirst" scope="col">Modifier and Type</th>
 145 <th class="colLast" scope="col">Method and Description</th>
 146 </tr>
 147 <tr class="altColor">
 148 <td class="colFirst"><code>void</code></td>
 149 <td class="colLast"><code><strong><a href="../../../org/scannotation/archiveiterator/FileIterator.html#close()">close</a></strong>()</code>
 150 <div class="block">Cleanup any open resources of the iterator</div>
 151 </td>
 152 </tr>
 153 <tr class="rowColor">
 154 <td class="colFirst"><code>protected static void</code></td>
 155 <td class="colLast"><code><strong><a href="../../../org/scannotation/archiveiterator/FileIterator.html#create(java.util.List,%20java.io.File,%20org.scannotation.archiveiterator.Filter)">create</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;list,
 156       <a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir,
 157       <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a>&nbsp;filter)</code>&nbsp;</td>
 158 </tr>
 159 <tr class="altColor">
 160 <td class="colFirst"><code>protected static void</code></td>
 161 <td class="colLast"><code><strong><a href="../../../org/scannotation/archiveiterator/FileIterator.html#create(java.util.List,%20java.io.File,%20org.scannotation.archiveiterator.Filter,%20java.lang.String)">create</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;list,
 162       <a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir,
 163       <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a>&nbsp;filter,
 164       <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)</code>&nbsp;</td>
 165 </tr>
 166 <tr class="rowColor">
 167 <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
 168 <td class="colLast"><code><strong><a href="../../../org/scannotation/archiveiterator/FileIterator.html#next()">next</a></strong>()</code>
 169 <div class="block">User is resposible for closing the InputStream returned</div>
 170 </td>
 171 </tr>
 172 </table>
 173 <ul class="blockList">
 174 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
 175 <!--   -->
 176 </a>
 177 <h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 178 <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
 179 </ul>
 180 </li>
 181 </ul>
 182 </li>
 183 </ul>
 184 </div>
 185 <div class="details">
 186 <ul class="blockList">
 187 <li class="blockList">
 188 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 189 <ul class="blockList">
 190 <li class="blockList"><a name="constructor_detail">
 191 <!--   -->
 192 </a>
 193 <h3>Constructor Detail</h3>
 194 <a name="FileIterator(java.io.File, org.scannotation.archiveiterator.Filter)">
 195 <!--   -->
 196 </a>
 197 <ul class="blockListLast">
 198 <li class="blockList">
 199 <h4>FileIterator</h4>
 200 <pre>public&nbsp;FileIterator(<a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;file,
 201             <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a>&nbsp;filter)</pre>
 202 </li>
 203 </ul>
 204 </li>
 205 </ul>
 206 <!-- ============ METHOD DETAIL ========== -->
 207 <ul class="blockList">
 208 <li class="blockList"><a name="method_detail">
 209 <!--   -->
 210 </a>
 211 <h3>Method Detail</h3>
 212 <a name="create(java.util.List, java.io.File, org.scannotation.archiveiterator.Filter)">
 213 <!--   -->
 214 </a>
 215 <ul class="blockList">
 216 <li class="blockList">
 217 <h4>create</h4>
 218 <pre>protected static&nbsp;void&nbsp;create(<a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;list,
 219           <a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir,
 220           <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a>&nbsp;filter)
 221                       throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
 222 <dl><dt><span class="strong">Throws:</span></dt>
 223 <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
 224 </li>
 225 </ul>
 226 <a name="create(java.util.List, java.io.File, org.scannotation.archiveiterator.Filter, java.lang.String)">
 227 <!--   -->
 228 </a>
 229 <ul class="blockList">
 230 <li class="blockList">
 231 <h4>create</h4>
 232 <pre>protected static&nbsp;void&nbsp;create(<a href="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;list,
 233           <a href="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir,
 234           <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a>&nbsp;filter,
 235           <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefix)
 236                       throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
 237 <dl><dt><span class="strong">Throws:</span></dt>
 238 <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
 239 </li>
 240 </ul>
 241 <a name="next()">
 242 <!--   -->
 243 </a>
 244 <ul class="blockList">
 245 <li class="blockList">
 246 <h4>next</h4>
 247 <pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;next()</pre>
 248 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#next()">StreamIterator</a></code></strong></div>
 249 <div class="block">User is resposible for closing the InputStream returned</div>
 250 <dl>
 251 <dt><strong>Specified by:</strong></dt>
 252 <dd><code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#next()">next</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></code></dd>
 253 <dt><span class="strong">Returns:</span></dt><dd>null if no more streams left to iterate on</dd></dl>
 254 </li>
 255 </ul>
 256 <a name="close()">
 257 <!--   -->
 258 </a>
 259 <ul class="blockListLast">
 260 <li class="blockList">
 261 <h4>close</h4>
 262 <pre>public&nbsp;void&nbsp;close()</pre>
 263 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#close()">StreamIterator</a></code></strong></div>
 264 <div class="block">Cleanup any open resources of the iterator</div>
 265 <dl>
 266 <dt><strong>Specified by:</strong></dt>
 267 <dd><code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></code></dd>
 268 </dl>
 269 </li>
 270 </ul>
 271 </li>
 272 </ul>
 273 </li>
 274 </ul>
 275 </div>
 276 </div>
 277 <!-- ========= END OF CLASS DATA ========= -->
 278 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 279 <div class="bottomNav"><a name="navbar_bottom">
 280 <!--   -->
 281 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 282 <!--   -->
 283 </a>
 284 <ul class="navList" title="Navigation">
 285 <li><a href="../../../overview-summary.html">Overview</a></li>
 286 <li><a href="package-summary.html">Package</a></li>
 287 <li class="navBarCell1Rev">Class</li>
 288 <li><a href="class-use/FileIterator.html">Use</a></li>
 289 <li><a href="package-tree.html">Tree</a></li>
 290 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 291 <li><a href="../../../index-all.html">Index</a></li>
 292 <li><a href="../../../help-doc.html">Help</a></li>
 293 </ul>
 294 </div>
 295 <div class="subNav">
 296 <ul class="navList">
 297 <li><a href="../../../org/scannotation/archiveiterator/DirectoryIteratorFactory.html" title="interface in org.scannotation.archiveiterator"><span class="strong">Prev Class</span></a></li>
 298 <li><a href="../../../org/scannotation/archiveiterator/FileProtocolIteratorFactory.html" title="class in org.scannotation.archiveiterator"><span class="strong">Next Class</span></a></li>
 299 </ul>
 300 <ul class="navList">
 301 <li><a href="../../../index.html?org/scannotation/archiveiterator/FileIterator.html" target="_top">Frames</a></li>
 302 <li><a href="FileIterator.html" target="_top">No Frames</a></li>
 303 </ul>
 304 <ul class="navList" id="allclasses_navbar_bottom">
 305 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
 306 </ul>
 307 <div>
 308 <script type="text/javascript"><!--
 309   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 310   if(window==top) {
 311     allClassesLink.style.display = "block";
 312   }
 313   else {
 314     allClassesLink.style.display = "none";
 315   }
 316   //-->
 317 </script>
 318 </div>
 319 <div>
 320 <ul class="subNavList">
 321 <li>Summary:&nbsp;</li>
 322 <li>Nested&nbsp;|&nbsp;</li>
 323 <li>Field&nbsp;|&nbsp;</li>
 324 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 325 <li><a href="#method_summary">Method</a></li>
 326 </ul>
 327 <ul class="subNavList">
 328 <li>Detail:&nbsp;</li>
 329 <li>Field&nbsp;|&nbsp;</li>
 330 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
 331 <li><a href="#method_detail">Method</a></li>
 332 </ul>
 333 </div>
 334 <a name="skip-navbar_bottom">
 335 <!--   -->
 336 </a></div>
 337 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 338 <p class="legalCopy"><small>Copyright &#169; 2015. All Rights Reserved.</small></p>
 339 </body>
 340 </html>