Module org.arakhne.afc.core.util
Package org.arakhne.afc.sizediterator
Class UnmodifiableSizedIterator<M>
- java.lang.Object
-
- org.arakhne.afc.sizediterator.UnmodifiableSizedIterator<M>
-
- Type Parameters:
M
- is the type of element.
- All Implemented Interfaces:
Iterator<M>
,SizedIterator<M>
public class UnmodifiableSizedIterator<M> extends Object implements SizedIterator<M>
Class that make unmodifiable a sized iterator.A sized iterator is an Iterator that is able to reply the size of the iterated collection and the number of elements that may be encountered in the next iterations.
This class provides features closed to
Collections.unmodifiableCollection(java.util.Collection)
but on sized iterators.This iterator disables the use of the function
Iterator.remove()
. This iterator implementation is a iterator; seeUnmodifiableIterator
for an utility class on a standard Iterator.- Version:
- 17.0 2020-01-04 14:41:38
- Author:
- Stéphane GALLAND
- See Also:
UnmodifiableIterator
- Maven Group Id:
- org.arakhne.afc.core
- Maven Artifact Id:
- util
-
-
Constructor Summary
Constructors Constructor Description UnmodifiableSizedIterator(SizedIterator<M> iterator)
Construct an iterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
-
UnmodifiableSizedIterator
public UnmodifiableSizedIterator(SizedIterator<M> iterator)
Construct an iterator.- Parameters:
iterator
- the iterator.
-
-
Method Detail
-
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 interfaceSizedIterator<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 interfaceSizedIterator<M>
- Returns:
- the index of the last element replied by
next()
.
-
totalSize
@Pure public int totalSize()
Description copied from interface:SizedIterator
Replies the count of elements in the iterated collection.- Specified by:
totalSize
in interfaceSizedIterator<M>
- Returns:
- the count of elements in the iterated collection.
-
-