AbortiveMultiIterator (Apache TinkerPop 3.7.2-SNAPSHOT API)

java.lang.Object
- org.apache.tinkerpop.gremlin.util.iterator.AbortiveMultiIterator<T>

All Implemented Interfaces:

Serializable, AutoCloseable, Iterator<T>
```
public final class AbortiveMultiIterator<T>
extends Object
implements Iterator<T>, Serializable, AutoCloseable
```
An Iterator that checks a Predicate prior to processing the specified child Iterator instances.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

AbortiveMultiIterator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addIterator(Iterator<T> iterator)`	Adds an `Iterator` that will always be iterated.
`void`	`addIterator(Iterator<T> iterator, Predicate<Long> check)`	Adds an `Iterator` that will iterate only if the `check` passes.
`void`	`clear()`
`void`	`close()`	Close the underlying iterators if auto-closeable.
`boolean`	`hasNext()`
`T`	`next()`
`void`	`remove()`

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

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - AbortiveMultiIterator
```
public AbortiveMultiIterator()
```
- Method Detail
  - addIterator
```
public void addIterator(Iterator<T> iterator)
```
    Adds an Iterator that will always be iterated.
  - addIterator
```
public void addIterator(Iterator<T> iterator,
                        Predicate<Long> check)
```
    Adds an Iterator that will iterate only if the check passes.
    
    Parameters:
    
    check - when returning true processing of the associated Iterator will proceed
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - clear
```
public void clear()
```
  - close
```
public void close()
```
    Close the underlying iterators if auto-closeable. Note that when Exception is thrown from any iterator in the for loop on closing, remaining iterators possibly left unclosed.
    
    Specified by:
    
    close in interface AutoCloseable