InterruptibleIterator (Apache Accumulo Core 3.0.0 API)

All Superinterfaces:

SortedKeyValueIterator<Key,Value>, YieldingKeyValueIterator<Key,Value>

All Known Subinterfaces:

FileSKVIterator

All Known Implementing Classes:

BloomFilterLayer.Reader, ColumnFamilySkippingIterator, EmptyIterator, LocalityGroupIterator, RFile.Reader, SequenceFileIterator, SortedMapIterator, SourceSwitchingIterator, TimeSettingIterator
```
public interface InterruptibleIterator
extends SortedKeyValueIterator<Key,Value>
```
Allows an iterator to be interrupted. Typically, once the interrupt flag is set the iterator will throw an InterruptedException if the interrupt is detected. Some iterators have been optimized to not always check the flag.
One example of a system interrupt is when a Tablet is being closed. If a Tablet has an active scan and an InterruptibleIterator is configured on that Table, then it will be interrupted when the Tablet is closed.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  void setInterruptFlag(AtomicBoolean flag)
  - Methods inherited from interface org.apache.accumulo.core.iterators.SortedKeyValueIterator
    deepCopy, getTopKey, getTopValue, hasTop, init, isRunningLowOnMemory, next, seek
  - Methods inherited from interface org.apache.accumulo.core.iterators.YieldingKeyValueIterator
    enableYielding

Method Detail

setInterruptFlag

void setInterruptFlag(AtomicBoolean flag)