Package com.github.tommyettinger.ds.support.util

Class StridingCharIterator

java.lang.Object

com.github.tommyettinger.ds.support.util.StridingCharIterator

All Implemented Interfaces:

CharIterator, Iterator<Character>

public class StridingCharIterator
extends Object
implements CharIterator

Wraps a CharIterator so that it starts at an offset, skipping that many items, then returning items that match a given stride, such as every other item, or every tenth item. If the offset is 0, this will try to return the first item and then any items matching the stride, so if the stride is 2, it will return the first item, skip one item, return the item after that, skip, return, skip, return, etc. This has undefined behavior if any items the CharIterator could return are modified during iteration.
You can change the iterator, offset, and stride at once using set(CharIterator, int, int), and can also just change the iterator with set(CharIterator).

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	available
protected boolean	end
protected int	index
CharIterator	iterator
protected char	next
protected int	offset
protected int	stride

Constructor Summary

Constructors

Constructor	Description
StridingCharIterator()
StridingCharIterator(CharIterator iterator, int offset, int stride)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
char	nextChar()	Returns the next char element in the iteration.
void	remove()	NOTE: this does not change the stride or offset, so the same sequence of values will be returned regardless of if some elements are removed with this method.
void	set(CharIterator iterator)
void	set(CharIterator iterator, int offset, int stride)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.tommyettinger.ds.support.util.CharIterator

forEachRemaining, next

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Details

iterator

public CharIterator iterator

offset

protected int offset

stride

protected int stride

index

protected int index

end

protected boolean end

available

protected boolean available

next

protected char next

Constructor Details

StridingCharIterator

public StridingCharIterator()

StridingCharIterator

public StridingCharIterator(CharIterator iterator,
 int offset,
 int stride)

Method Details

set

public void set(CharIterator iterator,
 int offset,
 int stride)

set

public void set(CharIterator iterator)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Character>

nextChar

public char nextChar()

Description copied from interface: CharIterator

Returns the next char element in the iteration.

Specified by:

nextChar in interface CharIterator

Returns:

the next char element in the iteration

remove

public void remove()

NOTE: this does not change the stride or offset, so the same sequence of values will be returned regardless of if some elements are removed with this method.

Specified by:

remove in interface Iterator<Character>