com.bigdata.striterator
Interface ICloseableIterator<E>

All Superinterfaces:
Iterator<E>
All Known Subinterfaces:
BigdataStatementIterator, BigdataValueIterator, IAsynchronousIterator<E>, IChunkedIterator<E>, IChunkedOrderedIterator<R>, IChunkedOrderedStriterator<I,E>, IChunkedStriterator<I,E>, IJustificationIterator
All Known Implementing Classes:
AbstractChunkedResolverator, BackchainOwlSameAsIterator, BackchainOwlSameAsPropertiesIterator, BackchainOwlSameAsPropertiesPIterator, BackchainOwlSameAsPropertiesPOIterator, BackchainOwlSameAsPropertiesSPIterator, BackchainOwlSameAsPropertiesSPOIterator, BackchainTypeResourceIterator, BackchainTypeResourceIterator.PushbackIterator, BigdataSolutionResolverator, BigdataStatementIteratorImpl, BigdataValueIteratorImpl, BlockingBuffer.BlockingIterator, ChunkConsumerIterator, ChunkedArrayIterator, ChunkedConvertingIterator, ChunkedOrderedStriterator, ChunkedResolvingIterator, ChunkedStriterator, ChunkedWrappedIterator, ClientAsynchronousIterator, ClosableEmptyIterator, ClosableSingleItemIterator, CloseableIteratorWrapper, DelegateChunkedIterator, DistinctSPOIterator, EmptyChunkedIterator, EmptyStatementIterator, FullyBufferedJustificationIterator, GenericChunkedOrderedStriterator, GenericChunkedStriterator, JustificationIterator, OwlSameAsPropertiesExpandingIterator, PushbackIterator, SingleValueChunkedIterator, SPOArrayIterator, ThickAsynchronousIterator, WrappedRemoteChunkedIterator

public interface ICloseableIterator<E>
extends Iterator<E>

An iterator that defines a close() method - you MUST close instances of this interface. Many implementation depends on this in order to release resources, terminate tasks, etc.

Version:
$Id: ICloseableIterator.java 2265 2009-10-26 12:51:06Z thompsonbry $
Author:
Bryan Thompson

Method Summary
 void close()
          Closes the iterator, releasing any associated resources.
 
Methods inherited from interface java.util.Iterator
hasNext, next, remove
 

Method Detail

close

void close()
Closes the iterator, releasing any associated resources. This method MAY be invoked safely if the iterator is already closed.

Note: Implementations that support Iterator.remove() MUST NOT eagerly close the iterator when it is exhausted since that would make it impossible to remove the last visited statement. Instead they MUST wait for an explicit close() by the application.



Copyright © 2006-2009 SYSTAP, LLC. All Rights Reserved.