speiger.src.collections.chars.collections

Interface CharBidirectionalIterator

All Superinterfaces:

CharIterator, java.util.Iterator<java.lang.Character>, ObjectBidirectionalIterator<java.lang.Character>, ObjectIterator<java.lang.Character>

All Known Subinterfaces:

CharListIterator

public interface CharBidirectionalIterator
extends CharIterator, ObjectBidirectionalIterator<java.lang.Character>

A Type-Specific ObjectBidirectionalIterator to reduce (un)boxing

Method Summary

Modifier and Type	Method and Description
default int	back(int amount) Reverses the Given amount of elements if possible.
boolean	hasPrevious() Returns true if the Iterator has a Previous element
default java.lang.Character	previous() Deprecated. Please use the corresponding type-specific function instead.
char	previousChar() Returns the Previous element of the iterator.
default int	skip(int amount) Skips the Given amount of elements if possible.

Methods inherited from interface speiger.src.collections.chars.collections.CharIterator

forEachRemaining, forEachRemaining, forEachRemaining, next, nextChar

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterator

forEachRemaining

Methods inherited from interface java.util.Iterator

hasNext, remove

Method Detail

hasPrevious

boolean hasPrevious()

Returns true if the Iterator has a Previous element

Specified by:

hasPrevious in interface ObjectBidirectionalIterator<java.lang.Character>

Returns:

true if the Iterator has a Previous element

previousChar

char previousChar()

Returns the Previous element of the iterator.

Returns:

the Previous element of the iterator.

Throws:

java.util.NoSuchElementException - if the iteration has no more elements

previous

@Deprecated
default java.lang.Character previous()

Deprecated. Please use the corresponding type-specific function instead.

Returns the Previous element of the iterator.

This default implementation delegates to the corresponding type-specific function.

Specified by:

previous in interface ObjectBidirectionalIterator<java.lang.Character>

Returns:

the Previous element of the iterator.

skip

default int skip(int amount)

Skips the Given amount of elements if possible. A Optimization function to skip elements faster if the implementation allows it.

Specified by:

skip in interface CharIterator

Specified by:

skip in interface ObjectIterator<java.lang.Character>

Parameters:

amount - the amount of elements that should be skipped

Returns:

the amount of elements that were skipped

back

default int back(int amount)

Reverses the Given amount of elements if possible. A Optimization function to reverse elements faster if the implementation allows it.

Specified by:

back in interface ObjectBidirectionalIterator<java.lang.Character>

Parameters:

amount - the amount of elements that should be reversed

Returns:

the amount of elements that were reversed