1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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>JarIterator (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">
12 <script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
14 parent.document.title="JarIterator (scannotation 1.0.4 API)";
19 <div>JavaScript is disabled on your browser.</div>
21 <!-- ========= START OF TOP NAVBAR ======= -->
22 <div class="topNav"><a name="navbar_top">
24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
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/JarIterator.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>
40 <li><a href="../../../org/scannotation/archiveiterator/IteratorFactory.html" title="class in org.scannotation.archiveiterator"><span class="strong">Prev Class</span></a></li>
41 <li><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator"><span class="strong">Next Class</span></a></li>
44 <li><a href="../../../index.html?org/scannotation/archiveiterator/JarIterator.html" target="_top">Frames</a></li>
45 <li><a href="JarIterator.html" target="_top">No Frames</a></li>
47 <ul class="navList" id="allclasses_navbar_top">
48 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
51 <script type="text/javascript"><!--
52 allClassesLink = document.getElementById("allclasses_navbar_top");
54 allClassesLink.style.display = "block";
57 allClassesLink.style.display = "none";
63 <ul class="subNavList">
64 <li>Summary: </li>
65 <li>Nested | </li>
66 <li>Field | </li>
67 <li><a href="#constructor_summary">Constr</a> | </li>
68 <li><a href="#method_summary">Method</a></li>
70 <ul class="subNavList">
71 <li>Detail: </li>
72 <li>Field | </li>
73 <li><a href="#constructor_detail">Constr</a> | </li>
74 <li><a href="#method_detail">Method</a></li>
77 <a name="skip-navbar_top">
80 <!-- ========= END OF TOP NAVBAR ========= -->
81 <!-- ======== START OF CLASS DATA ======== -->
83 <div class="subTitle">org.scannotation.archiveiterator</div>
84 <h2 title="Class JarIterator" class="title">Class JarIterator</h2>
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>
90 <ul class="inheritance">
91 <li>org.scannotation.archiveiterator.JarIterator</li>
95 <div class="description">
96 <ul class="blockList">
97 <li class="blockList">
99 <dt>All Implemented Interfaces:</dt>
100 <dd><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></dd>
104 <pre>public class <span class="strong">JarIterator</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>
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">
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"> </span></caption>
126 <th class="colOne" scope="col">Constructor and Description</th>
128 <tr class="altColor">
129 <td class="colOne"><code><strong><a href="../../../org/scannotation/archiveiterator/JarIterator.html#JarIterator(java.io.File,%20org.scannotation.archiveiterator.Filter)">JarIterator</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> file,
130 <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a> filter)</code> </td>
132 <tr class="rowColor">
133 <td class="colOne"><code><strong><a href="../../../org/scannotation/archiveiterator/JarIterator.html#JarIterator(java.io.InputStream,%20org.scannotation.archiveiterator.Filter)">JarIterator</a></strong>(<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> is,
134 <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a> filter)</code> </td>
139 <!-- ========== METHOD SUMMARY =========== -->
140 <ul class="blockList">
141 <li class="blockList"><a name="method_summary">
144 <h3>Method Summary</h3>
145 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
146 <caption><span>Methods</span><span class="tabEnd"> </span></caption>
148 <th class="colFirst" scope="col">Modifier and Type</th>
149 <th class="colLast" scope="col">Method and Description</th>
151 <tr class="altColor">
152 <td class="colFirst"><code>void</code></td>
153 <td class="colLast"><code><strong><a href="../../../org/scannotation/archiveiterator/JarIterator.html#close()">close</a></strong>()</code>
154 <div class="block">Cleanup any open resources of the iterator</div>
157 <tr class="rowColor">
158 <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>
159 <td class="colLast"><code><strong><a href="../../../org/scannotation/archiveiterator/JarIterator.html#next()">next</a></strong>()</code>
160 <div class="block">User is resposible for closing the InputStream returned</div>
164 <ul class="blockList">
165 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
168 <h3>Methods inherited from class 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>
169 <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>
176 <div class="details">
177 <ul class="blockList">
178 <li class="blockList">
179 <!-- ========= CONSTRUCTOR DETAIL ======== -->
180 <ul class="blockList">
181 <li class="blockList"><a name="constructor_detail">
184 <h3>Constructor Detail</h3>
185 <a name="JarIterator(java.io.File, org.scannotation.archiveiterator.Filter)">
188 <ul class="blockList">
189 <li class="blockList">
191 <pre>public JarIterator(<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> file,
192 <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a> filter)
193 throws <a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
194 <dl><dt><span class="strong">Throws:</span></dt>
195 <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
198 <a name="JarIterator(java.io.InputStream, org.scannotation.archiveiterator.Filter)">
201 <ul class="blockListLast">
202 <li class="blockList">
204 <pre>public JarIterator(<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> is,
205 <a href="../../../org/scannotation/archiveiterator/Filter.html" title="interface in org.scannotation.archiveiterator">Filter</a> filter)
206 throws <a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
207 <dl><dt><span class="strong">Throws:</span></dt>
208 <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
213 <!-- ============ METHOD DETAIL ========== -->
214 <ul class="blockList">
215 <li class="blockList"><a name="method_detail">
218 <h3>Method Detail</h3>
222 <ul class="blockList">
223 <li class="blockList">
225 <pre>public <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> next()</pre>
226 <div class="block"><strong>Description copied from interface: <code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#next()">StreamIterator</a></code></strong></div>
227 <div class="block">User is resposible for closing the InputStream returned</div>
229 <dt><strong>Specified by:</strong></dt>
230 <dd><code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#next()">next</a></code> in interface <code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></code></dd>
231 <dt><span class="strong">Returns:</span></dt><dd>null if no more streams left to iterate on</dd></dl>
237 <ul class="blockListLast">
238 <li class="blockList">
240 <pre>public void close()</pre>
241 <div class="block"><strong>Description copied from interface: <code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#close()">StreamIterator</a></code></strong></div>
242 <div class="block">Cleanup any open resources of the iterator</div>
244 <dt><strong>Specified by:</strong></dt>
245 <dd><code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html#close()">close</a></code> in interface <code><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator">StreamIterator</a></code></dd>
255 <!-- ========= END OF CLASS DATA ========= -->
256 <!-- ======= START OF BOTTOM NAVBAR ====== -->
257 <div class="bottomNav"><a name="navbar_bottom">
259 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
262 <ul class="navList" title="Navigation">
263 <li><a href="../../../overview-summary.html">Overview</a></li>
264 <li><a href="package-summary.html">Package</a></li>
265 <li class="navBarCell1Rev">Class</li>
266 <li><a href="class-use/JarIterator.html">Use</a></li>
267 <li><a href="package-tree.html">Tree</a></li>
268 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
269 <li><a href="../../../index-all.html">Index</a></li>
270 <li><a href="../../../help-doc.html">Help</a></li>
275 <li><a href="../../../org/scannotation/archiveiterator/IteratorFactory.html" title="class in org.scannotation.archiveiterator"><span class="strong">Prev Class</span></a></li>
276 <li><a href="../../../org/scannotation/archiveiterator/StreamIterator.html" title="interface in org.scannotation.archiveiterator"><span class="strong">Next Class</span></a></li>
279 <li><a href="../../../index.html?org/scannotation/archiveiterator/JarIterator.html" target="_top">Frames</a></li>
280 <li><a href="JarIterator.html" target="_top">No Frames</a></li>
282 <ul class="navList" id="allclasses_navbar_bottom">
283 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
286 <script type="text/javascript"><!--
287 allClassesLink = document.getElementById("allclasses_navbar_bottom");
289 allClassesLink.style.display = "block";
292 allClassesLink.style.display = "none";
298 <ul class="subNavList">
299 <li>Summary: </li>
300 <li>Nested | </li>
301 <li>Field | </li>
302 <li><a href="#constructor_summary">Constr</a> | </li>
303 <li><a href="#method_summary">Method</a></li>
305 <ul class="subNavList">
306 <li>Detail: </li>
307 <li>Field | </li>
308 <li><a href="#constructor_detail">Constr</a> | </li>
309 <li><a href="#method_detail">Method</a></li>
312 <a name="skip-navbar_bottom">
315 <!-- ======== END OF BOTTOM NAVBAR ======= -->
316 <p class="legalCopy"><small>Copyright © 2015. All Rights Reserved.</small></p>