OuterIterator

interface OuterIterator implements Iterator (View source)

Classes implementing OuterIterator can be used to iterate over iterators.

Methods

TValue
current()

Return the current element

from  Iterator
void
next()

Move forward to next element

from  Iterator
TKey|null
key()

Return the key of the current element

from  Iterator
bool
valid()

Checks if current position is valid

from  Iterator
void
rewind()

Rewind the Iterator to the first element

from  Iterator
Iterator|null
getInnerIterator()

Returns the inner iterator for the current entry.

Details

in Iterator at line 70
TValue current()

Return the current element

Return Value

TValue

Can return any type.

in Iterator at line 79
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

in Iterator at line 88
TKey|null key()

Return the key of the current element

Return Value

TKey|null

TKey on success, or null on failure.

in Iterator at line 98
bool valid()

Checks if current position is valid

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

in Iterator at line 107
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

at line 455
Iterator|null getInnerIterator()

Returns the inner iterator for the current entry.

Return Value

Iterator|null

The inner iterator for the current entry.