org.geotools.feature

Interface FeatureIterator<F extends Feature>

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

IMappingFeatureIterator, SimpleFeatureIterator

All Known Implementing Classes:

AbstractMappingFeatureIterator, ClippedFeatureIterator, ClippingFeatureIterator, ComplexFeatureIteratorImpl, ContentFeatureCollection.WrappingFeatureIterator, DataAccessMappingFeatureIterator, DecoratingFeatureIterator, DecoratingSimpleFeatureIterator, DelegateFeatureIterator, DelegateSimpleFeatureIterator, FeatureIteratorImpl, FeatureStreams.StreamFeatureIterator, FilteredIterator, FilteringFeatureIterator, FilteringSimpleFeatureIterator, ForceCoordinateSystemIterator, IndexedMappingFeatureIterator, MappingAttributeIterator, MaxFeaturesIterator, MaxFeaturesSimpleFeatureIterator, PartialIndexedMappingFeatureIterator, PostFilteringMappingFeatureIterator, PreGeneralizedFeatureIterator, PushBackFeatureIterator, ReprojectFeatureIterator, ReprojectingFeatureIterator, ReTypingFeatureIterator, SampleDataAccessFeatureIterator, SimpleFeatureIteratorImpl, SortedFeatureIterator, TotalIndexedMappingFeatureIterator, WrappingIterator, XmlMappingFeatureIterator

public interface FeatureIterator<F extends Feature>
extends Closeable

Streaming access to features, required to close() after use.

FeatureIterator is a drop in replacement for Iterator supporting a close method.

Sample use:

 FeatureIterator i = featureCollection.features()
 try {
    while( i.hasNext() ){
        SimpleFeature feature = i.next();
    }
 }
 finally {
    i.close();
 }
 

Author:

Ian Schneider

Method Summary

Modifier and Type	Method and Description
void	close() Closes this iterator and releases any system resources associated with it.
boolean	hasNext() Does another Feature exist in this Iteration.
F	next() Get the next Feature in this iteration.

Method Detail

hasNext

boolean hasNext()

Does another Feature exist in this Iteration.

Iterator defin: Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:

true if more Features exist, false otherwise.

next

F next()
throws NoSuchElementException

Get the next Feature in this iteration.

Returns:

The next Feature

Throws:

NoSuchElementException - If no more Features exist.

close

void close()

Closes this iterator and releases any system resources associated with it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable