info.aduna.iteration

Interface CloseableIteration<E,X extends Exception>

All Superinterfaces:

Iteration<E,X>

All Known Implementing Classes:

CloseableIterationBase, CloseableIteratorIteration, ConvertingIteration, DelayedIteration, DistinctIteration, EmptyIteration, ExceptionConvertingIteration, FilterIteration, IntersectIteration, IterationWrapper, LimitIteration, LookAheadIteration, MinusIteration, OffsetIteration, ReducedIteration, SingletonIteration, TimeLimitIteration, UnionIteration

public interface CloseableIteration<E,X extends Exception>
extends Iteration<E,X>

An Iteration that can be closed to free resources that it is holding. CloseableIterations automatically free their resources when exhausted. If not read until exhaustion or if you want to make sure the iteration is properly closed, any code using the iterator should be placed in a try-catch-finally block, closing the iteration in the finally, e.g.:

 CloseableIteration<Object, Exception> iter = ...
 try {
    // read objects from the iterator
 }
 catch(Exception e) {
   // process the exception that can be thrown while processing.
 }
 finally {
    iter.close();
 }
 

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this iteration, freeing any resources that it is holding.

Methods inherited from interface info.aduna.iteration.Iteration

hasNext, next, remove

Method Detail

close

void close()
           throws X extends Exception

Closes this iteration, freeing any resources that it is holding. If the iteration has already been closed then invoking this method has no effect.

Throws:

X extends Exception