Interface IntIterator

All Superinterfaces:
java.util.Iterator<java.lang.Integer>, java.util.PrimitiveIterator<java.lang.Integer,​java.util.function.IntConsumer>, java.util.PrimitiveIterator.OfInt
All Known Subinterfaces:
IntBidirectionalIterator, IntBigListIterator, IntListIterator
All Known Implementing Classes:
AbstractIntBidirectionalIterator, AbstractIntBigListIterator, AbstractIntIterator, AbstractIntListIterator, IntBigListIterators.AbstractIndexBasedBigIterator, IntBigListIterators.AbstractIndexBasedBigListIterator, IntBigListIterators.BigListIteratorListIterator, IntBigListIterators.EmptyBigListIterator, IntBigListIterators.UnmodifiableBigListIterator, IntIterators.AbstractIndexBasedIterator, IntIterators.AbstractIndexBasedListIterator, IntIterators.EmptyIterator, IntIterators.UnmodifiableBidirectionalIterator, IntIterators.UnmodifiableIterator, IntIterators.UnmodifiableListIterator

public interface IntIterator
extends java.util.PrimitiveIterator.OfInt
A type-specific Iterator; provides an additional method to avoid (un)boxing, and the possibility to skip elements.
See Also:
Iterator
  • Nested Class Summary

    Nested classes/interfaces inherited from interface java.util.PrimitiveIterator

    java.util.PrimitiveIterator.OfDouble, java.util.PrimitiveIterator.OfInt, java.util.PrimitiveIterator.OfLong
  • Method Summary

    Modifier and Type Method Description
    default void forEachRemaining​(IntConsumer action)
    Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
    default void forEachRemaining​(java.util.function.Consumer<? super java.lang.Integer> action)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default java.lang.Integer next()
    Deprecated.
    Please use the corresponding type-specific method instead.
    int nextInt()
    Returns the next element as a primitive type.
    default int skip​(int n)
    Skips the given number of elements.

    Methods inherited from interface java.util.Iterator

    hasNext, remove

    Methods inherited from interface java.util.PrimitiveIterator.OfInt

    forEachRemaining
  • Method Details

    • nextInt

      int nextInt()
      Returns the next element as a primitive type.
      Specified by:
      nextInt in interface java.util.PrimitiveIterator.OfInt
      Returns:
      the next element in the iteration.
      See Also:
      Iterator.next()
    • next

      @Deprecated default java.lang.Integer next()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      next in interface java.util.Iterator<java.lang.Integer>
      Specified by:
      next in interface java.util.PrimitiveIterator.OfInt
    • forEachRemaining

      default void forEachRemaining​(IntConsumer action)
      Performs the given action for each remaining element until all elements have been processed or the action throws an exception.

      WARNING: Overriding this method is almost always a mistake, as this overload only exists to disambiguate. Instead, override the forEachRemaining() overload that uses the JDK's primitive consumer type (e.g. IntConsumer).

      If Java supported final default methods, this would be one, but sadly it does not.

      If you checked and are overriding the version with java.util.function.XConsumer, and still see this warning, then your IDE is incorrectly conflating this method with the proper method to override, and you can safely ignore this message.

      Parameters:
      action - the action to be performed for each element.
      Since:
      8.5.0
      See Also:
      Iterator.forEachRemaining(java.util.function.Consumer)
    • forEachRemaining

      @Deprecated default void forEachRemaining​(java.util.function.Consumer<? super java.lang.Integer> action)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      forEachRemaining in interface java.util.Iterator<java.lang.Integer>
      Specified by:
      forEachRemaining in interface java.util.PrimitiveIterator.OfInt
    • skip

      default int skip​(int n)
      Skips the given number of elements.

      The effect of this call is exactly the same as that of calling next() for n times (possibly stopping if Iterator.hasNext() becomes false).

      Parameters:
      n - the number of elements to skip.
      Returns:
      the number of elements actually skipped.
      See Also:
      Iterator.next()