Module org.arakhne.afc.core.util

Package org.arakhne.afc.sizediterator

Class MultiSizedIterator<M>

java.lang.Object

org.arakhne.afc.sizediterator.MultiSizedIterator<M>

Type Parameters:

M - is the type of element.

All Implemented Interfaces:

Iterator<M>, SizedIterator<M>

public class MultiSizedIterator<M>
extends Object
implements SizedIterator<M>

A sized iterator that is based on the used of a collection of sized iterators.

Version:

17.0 2020-01-04 14:41:38

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

util

Constructor Summary

Constructors

Constructor	Description
MultiSizedIterator()	Construct an iterator.

Method Summary

Modifier and Type	Method	Description
void	addIterator(SizedIterator<? extends M> iterator)	Add an iterator in the list of iterators.
boolean	hasNext()
int	index()	Replies the position of the last replied element in the iterated collection.
M	next()
int	rest()	Replies the count of elements which are not replied by the iterator.
int	totalSize()	Replies the count of elements in the iterated collection.

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, remove

Constructor Detail

MultiSizedIterator

public MultiSizedIterator()

Construct an iterator.

Method Detail

addIterator

public void addIterator(SizedIterator<? extends M> iterator)

Add an iterator in the list of iterators.

Parameters:

iterator - the iterator.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<M>

next

public M next()

Specified by:

next in interface Iterator<M>

totalSize

@Pure
public int totalSize()

Description copied from interface: SizedIterator

Replies the count of elements in the iterated collection.

Specified by:

totalSize in interface SizedIterator<M>

Returns:

the count of elements in the iterated collection.

rest

@Pure
public int rest()

Description copied from interface: SizedIterator

Replies the count of elements which are not replied by the iterator.

Specified by:

rest in interface SizedIterator<M>

Returns:

the count of elements which are not replied by the iterator.

index

@Pure
public int index()

Description copied from interface: SizedIterator

Replies the position of the last replied element in the iterated collection.

Specified by:

index in interface SizedIterator<M>

Returns:

the index of the last element replied by next().