io.atomix.core.iterator

Interface AsyncIterator<T>

public interface AsyncIterator<T>

Asynchronous iterator.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close() Closes the iterator.
CompletableFuture<Boolean>	hasNext() Returns whether the iterator has a next item.
CompletableFuture<T>	next() Returns the next item in the iterator.
default Iterator<T>	sync() Returns a synchronous iterator.
default Iterator<T>	sync(Duration timeout) Returns a synchronous iterator.

Method Detail

hasNext

CompletableFuture<Boolean> hasNext()

Returns whether the iterator has a next item.

Returns:

whether a next item exists in the iterator

next

CompletableFuture<T> next()

Returns the next item in the iterator.

Returns:

the next item in the iterator

close

CompletableFuture<Void> close()

Closes the iterator.

Returns:

a future to be completed once the iterator has been closed

sync

default Iterator<T> sync()

Returns a synchronous iterator.

Returns:

the synchronous iterator

sync

default Iterator<T> sync(Duration timeout)

Returns a synchronous iterator.

Parameters:

timeout - the iterator operation timeout

Returns:

the synchronous iterator