01: /*
02: (c) Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Hewlett-Packard Development Company, LP
03: [See end of file]
04: $Id: ClosableIterator.java,v 1.11 2008/01/02 12:07:35 andy_seaborne Exp $
05: */
06:
07: package com.hp.hpl.jena.util.iterator;
08:
09: import java.util.Iterator;
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.11 2008/01/02 12:07:35 andy_seaborne Exp $
25: */
26:
27: public interface ClosableIterator extends Iterator {
28: /**
29: Close the iterator. Other oeprations on this iterator may now throw an exception. A
30: ClosableIterator may be closed as many times as desired - the subsequent
31: calls do nothing.
32: */
33: public void close();
34: }
35:
36: /*
37: * (c) Copyright 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Hewlett-Packard Development Company, LP
38: * All rights reserved.
39: *
40: * Redistribution and use in source and binary forms, with or without
41: * modification, are permitted provided that the following conditions
42: * are met:
43: * 1. Redistributions of source code must retain the above copyright
44: * notice, this list of conditions and the following disclaimer.
45: * 2. Redistributions in binary form must reproduce the above copyright
46: * notice, this list of conditions and the following disclaimer in the
47: * documentation and/or other materials provided with the distribution.
48: * 3. The name of the author may not be used to endorse or promote products
49: * derived from this software without specific prior written permission.
50:
51: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
52: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
53: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
54: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
55: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
56: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
60: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61: *
62: * StmtIterator.java
63: *
64: * Created on 28 July 2000, 13:44
65: */
|