Class EmptyIterator<M>

  • Type Parameters:
    M - is the type of element.
    All Implemented Interfaces:
    Iterator<M>, SizedIterator<M>

    public class EmptyIterator<M>
    extends Object
    implements SizedIterator<M>
    Sized iterator on an empty collection.

    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.

    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 Detail

      • EmptyIterator

        protected EmptyIterator()
        Construct an iterator.
    • Method Detail

      • singleton

        @Pure
        public static <M> EmptyIterator<M> singleton()
        Replies the singleton.
        Type Parameters:
        M - is the type of the element to iterate on.
        Returns:
        the singleton.
      • hasNext

        @Pure
        public final boolean hasNext()
        Specified by:
        hasNext in interface Iterator<M>
      • next

        public final M next()
        Specified by:
        next in interface Iterator<M>
      • rest

        @Pure
        public final 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 final 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().
      • totalSize

        @Pure
        public final 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.