Package org.apache.uima.cas.impl
Class FSIteratorWrapperDoubleCheck<T extends FeatureStructure>
java.lang.Object
org.apache.uima.cas.impl.FSIteratorImplBase<T>
org.apache.uima.cas.impl.FSIteratorWrapperDoubleCheck<T>
- Type Parameters:
T- -
- All Implemented Interfaces:
Iterator<T>,FSIterator<T>
Only used for debugging
Takes two iterators, and compares them; returns the 1st, throws error if unequal
-
Method Summary
Modifier and TypeMethodDescriptioncopy()Copy this iterator.get()Get the structure the iterator is pointing at.booleanisValid()Check if this iterator is valid.voidMove the iterator to the first Feature Structure that is equal tofs.voidMove the iterator to the first element.voidMove the iterator to the last element.voidAdvance the iterator.voidMove the iterator one element back.toString()Methods inherited from class org.apache.uima.cas.impl.FSIteratorImplBase
hasNext, next, removeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Iterator
forEachRemaining
-
Method Details
-
toString
-
isValid
public boolean isValid()Description copied from interface:FSIteratorCheck if this iterator is valid.- Returns:
trueif the iterator is valid.- See Also:
-
get
Description copied from interface:FSIteratorGet the structure the iterator is pointing at.- Returns:
- The structure the iterator is pointing at.
- See Also:
-
moveToNext
public void moveToNext()Description copied from interface:FSIteratorAdvance the iterator. This may invalidate the iterator.- See Also:
-
moveToPrevious
public void moveToPrevious()Description copied from interface:FSIteratorMove the iterator one element back. This may invalidate the iterator.- See Also:
-
moveToFirst
public void moveToFirst()Description copied from interface:FSIteratorMove the iterator to the first element. The iterator will be valid iff the underlying collection is non-empty. Allowed even if the underlying indexes being iterated over were modified.- See Also:
-
moveToLast
public void moveToLast()Description copied from interface:FSIteratorMove the iterator to the last element. The iterator will be valid iff the underlying collection is non-empty. Allowed even if the underlying indexes being iterated over were modified.- See Also:
-
copy
Description copied from interface:FSIteratorCopy this iterator.- Returns:
- A copy of this iterator, pointing at the same element.
- See Also:
-
moveTo
Description copied from interface:FSIteratorMove the iterator to the first Feature Structure that is equal tofs. First means the earliest one occurring in the index, in case multiple FSs that are "equal" to fs are in the index. If no such feature structure exists in the underlying collection, set the iterator to the "insertion point" forfs, i.e., to a point where the current feature structure is greater thanfs, and the previous one is less thanfs.If the fs is greater than all of the entries in the index, the moveTo cannot set the iterator to an insertion point where the current feature structure is greater than fs, so it marks the iterator "invalid".
If the underlying index is a bag index, no ordering is present, and the moveTo operation moves to the fs which is the same identical fs as the key. If no such fs is in the index, the iterator is marked invalid.
- Parameters:
fs- The feature structure the iterator that supplies the comparison information. It must be of type T or a subtype of T.- See Also:
-