KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > hp > hpl > jena > util > iterator > ClosableIterator


1 /*
2   (c) Copyright 2001, 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
3   [See end of file]
4   $Id: ClosableIterator.java,v 1.8 2005/02/21 12:19:14 andy_seaborne Exp $
5 */
6
7 package com.hp.hpl.jena.util.iterator;
8
9 import java.util.Iterator JavaDoc;
10
11 /**
12     An iterator which should be closed after use. Some iterators take up resources which
13     should be free'd as soon as possible, eg large structures which can be discarded
14     early, or external resources such as database cursors.
15 <p>
16     Users of ClosableIterators (and thus of ExtendedIterator) should close the iterator
17     when they are done with it, whether because they have found a desired element
18     or because they have reached the end. If they do not, resources may leak or be
19     reclaimed unpredictably or much later than convenient.
20 <p>
21     Implementors are encouraged to dispose of resources as soon as is convenient.
22  
23     @author bwm
24     @version $Id: ClosableIterator.java,v 1.8 2005/02/21 12:19:14 andy_seaborne Exp $
25  */
26
27 public interface ClosableIterator extends Iterator JavaDoc
28     {
29     /**
30         Close the iterator. Other oeprations on this iterator may now throw an exception. A
31         ClosableIterator may be closed as many times as desired - the subsequent
32         calls do nothing.
33     */
34     public void close();
35     }
36
37 /*
38  * (c) Copyright 2001, 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
39  * All rights reserved.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  * notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  * notice, this list of conditions and the following disclaimer in the
48  * documentation and/or other materials provided with the distribution.
49  * 3. The name of the author may not be used to endorse or promote products
50  * derived from this software without specific prior written permission.
51
52  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
53  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
56  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
57  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
61  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  *
63  * StmtIterator.java
64  *
65  * Created on 28 July 2000, 13:44
66  */
Popular Tags