Package org.apache.uima.internal.util

Interface ComparableFSIterator<F extends FeatureStructure>

All Superinterfaces:

Comparable<FSIterator<F>>, FSIterator<F>, Iterator<F>, ListIterator<F>

public interface ComparableFSIterator<F extends FeatureStructure>
extends FSIterator<F>, Comparable<FSIterator<F>>

Interface for a comparable FSIterator. This allows two iterators to be compared with each other. Two IntIterators are compared according to the element that would be returned by the next call to next(). The purpose of this is for keeping multiple iterators, one for each subtype of a type, in a sorted order, when desiring to iterate over a type and its subtypes, in a combined merged order. The comparable part is only needed for iterators over Sorted indexes. Iterators over Bags and Sets have no ordering requirement.

Method Summary

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apache.uima.cas.FSIterator

add, copy, get, getNvc, getType, hasNext, hasPrevious, isValid, moveTo, moveToFirst, moveToLast, moveToNext, moveToNextNvc, moveToPrevious, moveToPreviousNvc, next, nextIndex, nextNvc, previous, previousIndex, previousNvc, remove, set, size, spliterator, stream

Methods inherited from interface java.util.Iterator

forEachRemaining