Renaming artifact and packages
[scannotation] / src / main / java / org / scannotation / archiveiterator / StreamIterator.java
1 package org.scannotation.archiveiterator;
2
3 import java.io.InputStream;
4
5 /**
6  * Simpler iterator than java.util.iterator.  Things like JarInputStream does not allow you to implement hasNext()
7  *
8  * @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
9  * @version $Revision: 1 $
10  */
11 public interface StreamIterator
12 {
13    /**
14     * User is resposible for closing the InputStream returned
15     *
16     * @return null if no more streams left to iterate on
17     */
18    InputStream next();
19
20    /**
21     * Cleanup any open resources of the iterator
22     *
23     */
24    void close();
25 }