java.lang.Object
- org.apache.uima.cas.impl.LowLevelIterator_empty<T>

All Implemented Interfaces:

java.util.Iterator<T>, java.util.ListIterator<T>, FSIterator<T>, LowLevelIterator<T>
```
public class LowLevelIterator_empty<T extends FeatureStructure>
extends java.lang.Object
implements LowLevelIterator<T>
```
An empty Low-level FS iterator

Field Summary
- Fields inherited from interface org.apache.uima.cas.impl.LowLevelIterator
  FS_ITERATOR_LOW_LEVEL_EMPTY, IS_ORDERED

Constructor Summary

Constructors
Constructor Description

LowLevelIterator_empty()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LowLevelIterator_empty<T>`	`copy()`	Copy this iterator.
`java.util.Comparator<TOP>`	`getComparator()`
`T`	`getNvc()`	Get the structure the iterator is pointing at.
`Type`	`getType()`
`boolean`	`isIndexesHaveBeenUpdated()`
`boolean`	`isValid()`	Check if this iterator is valid.
`LowLevelIndex<T>`	`ll_getIndex()`	Get the index for just the top most type of this iterator (excludes subtypes).
`int`	`ll_indexSizeMaybeNotCurrent()`
`int`	`ll_maxAnnotSpan()`
`boolean`	`maybeReinitIterator()`	Internal use
`void`	`moveToFirstNoReinit()`	Internal use same as moveToFirst, but won't reset to use current contents of index if index has changed
`void`	`moveToLastNoReinit()`	Internal use same as moveToLast, but won't reset to use current contents of index if index has changed
`void`	`moveToNextNvc()`	version of moveToNext which bypasses the isValid check - call only if you've just done this check yourself
`void`	`moveToNoReinit(FeatureStructure fs)`	Internal use same as moveTo(fs), but won't reset to use current contents of index if index has changed
`void`	`moveToPreviousNvc()`	version of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourself
`int`	`size()`	return the size of the collection being iterated over, if available.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.uima.cas.FSIterator
add, get, hasNext, hasPrevious, moveToNext, moveToPrevious, next, nextIndex, nextNvc, previous, previousIndex, previousNvc, remove, set, spliterator, stream

Methods inherited from interface java.util.Iterator
forEachRemaining

Methods inherited from interface org.apache.uima.cas.impl.LowLevelIterator
getArrayList, isMoveToSupported, ll_get, ll_remove, moveTo, moveTo, moveToFirst, moveToLast

- Constructor Detail
  - LowLevelIterator_empty
```
public LowLevelIterator_empty()
```
- Method Detail
  - isValid
```
public boolean isValid()
```
    Description copied from interface: FSIterator
    
    Check if this iterator is valid.
    
    Specified by:
    
    isValid in interface FSIterator<T extends FeatureStructure>
    
    Returns:
    
    true if the iterator is valid.
  - getNvc
```
public T getNvc()
```
    Description copied from interface: FSIterator
    
    Get the structure the iterator is pointing at. Throws various unchecked exceptions, if the iterator is not valid
    
    Specified by:
    
    getNvc in interface FSIterator<T extends FeatureStructure>
    
    Returns:
    
    The structure the iterator is pointing at.
  - moveToFirstNoReinit
```
public void moveToFirstNoReinit()
```
    Description copied from interface: LowLevelIterator
    
    Internal use same as moveToFirst, but won't reset to use current contents of index if index has changed
    
    Specified by:
    
    moveToFirstNoReinit in interface LowLevelIterator<T extends FeatureStructure>
  - moveToLastNoReinit
```
public void moveToLastNoReinit()
```
    Description copied from interface: LowLevelIterator
    
    Internal use same as moveToLast, but won't reset to use current contents of index if index has changed
    
    Specified by:
    
    moveToLastNoReinit in interface LowLevelIterator<T extends FeatureStructure>
  - moveToNoReinit
```
public void moveToNoReinit(FeatureStructure fs)
```
    Description copied from interface: LowLevelIterator
    
    Internal use same as moveTo(fs), but won't reset to use current contents of index if index has changed
    
    Specified by:
    
    moveToNoReinit in interface LowLevelIterator<T extends FeatureStructure>
    
    Parameters:
    
    fs - the fs to use as the template identifying the place to move to
  - copy
```
public LowLevelIterator_empty<T> copy()
```
    Description copied from interface: FSIterator
    
    Copy this iterator.
    
    Specified by:
    
    copy in interface FSIterator<T extends FeatureStructure>
    
    Returns:
    
    A copy of this iterator, pointing at the same element.
  - moveToNextNvc
```
public void moveToNextNvc()
```
    Description copied from interface: FSIterator
    
    version of moveToNext which bypasses the isValid check - call only if you've just done this check yourself
    
    Specified by:
    
    moveToNextNvc in interface FSIterator<T extends FeatureStructure>
  - moveToPreviousNvc
```
public void moveToPreviousNvc()
```
    Description copied from interface: FSIterator
    
    version of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourself
    
    Specified by:
    
    moveToPreviousNvc in interface FSIterator<T extends FeatureStructure>
  - ll_indexSizeMaybeNotCurrent
```
public int ll_indexSizeMaybeNotCurrent()
```
    Specified by:
    
    ll_indexSizeMaybeNotCurrent in interface LowLevelIterator<T extends FeatureStructure>
    
    Returns:
    
    The size of the index. In case of copy-on-write, this returns the size of the index at the time the iterator was created, or at the last moveTo, moveToFirst, or moveToLast. To get the current index size, use ll_getIndex().getSize()
  - ll_maxAnnotSpan
```
public int ll_maxAnnotSpan()
```
    Specified by:
    
    ll_maxAnnotSpan in interface LowLevelIterator<T extends FeatureStructure>
    
    Returns:
    
    an estimate of the maximum span over all annotations (end - begin)
  - ll_getIndex
```
public LowLevelIndex<T> ll_getIndex()
```
    Description copied from interface: LowLevelIterator
    
    Get the index for just the top most type of this iterator (excludes subtypes).
    
    Specified by:
    
    ll_getIndex in interface LowLevelIterator<T extends FeatureStructure>
    
    Returns:
    
    The index.
  - isIndexesHaveBeenUpdated
```
public boolean isIndexesHaveBeenUpdated()
```
    Specified by:
    
    isIndexesHaveBeenUpdated in interface LowLevelIterator<T extends FeatureStructure>
    
    Returns:
    
    true if one or more of the underlying indexes this iterator goes over, has been updated since initialization or resetting operation (moveToFirst/Last/feature_structure). This includes empty iterators becoming non-empty.
  - maybeReinitIterator
```
public boolean maybeReinitIterator()
```
    Description copied from interface: LowLevelIterator
    
    Internal use
    
    Specified by:
    
    maybeReinitIterator in interface LowLevelIterator<T extends FeatureStructure>
    
    Returns:
    
    true if the iterator was refreshed to match the current index
  - getComparator
```
public java.util.Comparator<TOP> getComparator()
```
    Specified by:
    
    getComparator in interface LowLevelIterator<T extends FeatureStructure>
    
    Returns:
    
    the comparator used by this iterator. It is always a withoutID style, and may be either a withType or NoType style.
  - getType
```
public Type getType()
```
    Specified by:
    
    getType in interface FSIterator<T extends FeatureStructure>
    
    Returns:
    
    the type this iterator is over
  - size
```
public int size()
```
    Description copied from interface: FSIterator
    
    return the size of the collection being iterated over, if available. Because the iterator can move forwards and backwards, the size is the total size that the iterator would iterate over, starting at the first element thru the last element. This may be inefficient to compute.
    
    Specified by:
    
    size in interface FSIterator<T extends FeatureStructure>
    
    Returns:
    
    the size of the collection being iterated over.

Class LowLevelIterator_empty<T extends FeatureStructure>

Field Summary

Fields inherited from interface org.apache.uima.cas.impl.LowLevelIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

Methods inherited from interface org.apache.uima.cas.impl.LowLevelIterator

Constructor Detail

LowLevelIterator_empty

Method Detail

isValid

getNvc

moveToFirstNoReinit

moveToLastNoReinit

moveToNoReinit

copy

moveToNextNvc

moveToPreviousNvc

ll_indexSizeMaybeNotCurrent

ll_maxAnnotSpan

ll_getIndex

isIndexesHaveBeenUpdated

maybeReinitIterator

getComparator

getType

size