Spliterator.OfInt (Java SE 9 & JDK 9 ) (original) (raw)

• All Superinterfaces:
  [Spliterator](../../java/util/Spliterator.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang")>, [Spliterator.OfPrimitive](../../java/util/Spliterator.OfPrimitive.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang"),[IntConsumer](../../java/util/function/IntConsumer.html "interface in java.util.function"),[Spliterator.OfInt](../../java/util/Spliterator.OfInt.html "interface in java.util")>
  All Known Implementing Classes:
  [Spliterators.AbstractIntSpliterator](../../java/util/Spliterators.AbstractIntSpliterator.html "class in java.util")
  Enclosing interface:
  Spliterator<T>

public static interface Spliterator.OfInt
extends Spliterator.OfPrimitive<Integer,IntConsumer,Spliterator.OfInt>
A Spliterator specialized for int values.
Since:
1.8

• • Nested Class Summary

     * ### Nested classes/interfaces inherited from interface java.util.[Spliterator](../../java/util/Spliterator.html "interface in java.util")  
     `[Spliterator.OfDouble](../../java/util/Spliterator.OfDouble.html "interface in java.util"), [Spliterator.OfInt](../../java/util/Spliterator.OfInt.html "interface in java.util"), [Spliterator.OfLong](../../java/util/Spliterator.OfLong.html "interface in java.util"), [Spliterator.OfPrimitive](../../java/util/Spliterator.OfPrimitive.html "interface in java.util")<[T](../../java/util/Spliterator.OfPrimitive.html "type parameter in Spliterator.OfPrimitive"),[T_CONS](../../java/util/Spliterator.OfPrimitive.html "type parameter in Spliterator.OfPrimitive"),[T_SPLITR](../../java/util/Spliterator.OfPrimitive.html "type parameter in Spliterator.OfPrimitive") extends [Spliterator.OfPrimitive](../../java/util/Spliterator.OfPrimitive.html "interface in java.util")<[T](../../java/util/Spliterator.OfPrimitive.html "type parameter in Spliterator.OfPrimitive"),[T_CONS](../../java/util/Spliterator.OfPrimitive.html "type parameter in Spliterator.OfPrimitive"),[T_SPLITR](../../java/util/Spliterator.OfPrimitive.html "type parameter in Spliterator.OfPrimitive")>>`  

  • Field Summary

    * ### Fields inherited from interface java.util.[Spliterator](../../java/util/Spliterator.html "interface in java.util")  
    `[CONCURRENT](../../java/util/Spliterator.html#CONCURRENT), [DISTINCT](../../java/util/Spliterator.html#DISTINCT), [IMMUTABLE](../../java/util/Spliterator.html#IMMUTABLE), [NONNULL](../../java/util/Spliterator.html#NONNULL), [ORDERED](../../java/util/Spliterator.html#ORDERED), [SIZED](../../java/util/Spliterator.html#SIZED), [SORTED](../../java/util/Spliterator.html#SORTED), [SUBSIZED](../../java/util/Spliterator.html#SUBSIZED)`  

  • Method Summary

  All Methods Instance Methods Abstract Methods Default Methods

  Modifier and Type	Method	Description
  default void	forEachRemaining​(Consumer<? super Integer> action)	Performs the given action for each remaining element, sequentially in the current thread, until all elements have been processed or the action throws an exception.
  default void	forEachRemaining​(IntConsumer action)	Performs the given action for each remaining element, sequentially in the current thread, until all elements have been processed or the action throws an exception.
  default boolean	tryAdvance​(Consumer<? super Integer> action)	If a remaining element exists, performs the given action on it, returning true; else returns false.
  boolean	tryAdvance​(IntConsumer action)	If a remaining element exists, performs the given action on it, returning true; else returns false.
  Spliterator.OfInt	trySplit​()	If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.

     * ### Methods inherited from interface java.util.[Spliterator](../../java/util/Spliterator.html "interface in java.util")  
     `[characteristics](../../java/util/Spliterator.html#characteristics--), [estimateSize](../../java/util/Spliterator.html#estimateSize--), [getComparator](../../java/util/Spliterator.html#getComparator--), [getExactSizeIfKnown](../../java/util/Spliterator.html#getExactSizeIfKnown--), [hasCharacteristics](../../java/util/Spliterator.html#hasCharacteristics-int-)`

• • Method Detail

     * #### trySplit  
     [Spliterator.OfInt](../../java/util/Spliterator.OfInt.html "interface in java.util") trySplit​()  
     Description copied from interface: `[Spliterator](../../java/util/Spliterator.html#trySplit--)`  
     If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.  
     If this Spliterator is [Spliterator.ORDERED](../../java/util/Spliterator.html#ORDERED), the returned Spliterator must cover a strict prefix of the elements.  
     Unless this Spliterator covers an infinite number of elements, repeated calls to `trySplit()` must eventually return `null`. Upon non-null return:  
              * the value reported for `estimateSize()` before splitting, must, after splitting, be greater than or equal to `estimateSize()` for this and the returned Spliterator; and  
              * if this Spliterator is `SUBSIZED`, then `estimateSize()` for this spliterator before splitting must be equal to the sum of`estimateSize()` for this and the returned Spliterator after splitting.  
     This method may return `null` for any reason, including emptiness, inability to split after traversal has commenced, data structure constraints, and efficiency considerations.  
     Specified by:  
     `[trySplit](../../java/util/Spliterator.html#trySplit--)` in interface `[Spliterator](../../java/util/Spliterator.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang")>`  
     Specified by:  
     `[trySplit](../../java/util/Spliterator.OfPrimitive.html#trySplit--)` in interface `[Spliterator.OfPrimitive](../../java/util/Spliterator.OfPrimitive.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang"),[IntConsumer](../../java/util/function/IntConsumer.html "interface in java.util.function"),[Spliterator.OfInt](../../java/util/Spliterator.OfInt.html "interface in java.util")>`  
     Returns:  
     a `Spliterator` covering some portion of the elements, or `null` if this spliterator cannot be split  
     * #### tryAdvance  
     boolean tryAdvance​([IntConsumer](../../java/util/function/IntConsumer.html "interface in java.util.function") action)  
     If a remaining element exists, performs the given action on it, returning `true`; else returns `false`. If this Spliterator is [Spliterator.ORDERED](../../java/util/Spliterator.html#ORDERED) the action is performed on the next element in encounter order. Exceptions thrown by the action are relayed to the caller.  
     Specified by:  
     `[tryAdvance](../../java/util/Spliterator.OfPrimitive.html#tryAdvance-T%5FCONS-)` in interface `[Spliterator.OfPrimitive](../../java/util/Spliterator.OfPrimitive.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang"),[IntConsumer](../../java/util/function/IntConsumer.html "interface in java.util.function"),[Spliterator.OfInt](../../java/util/Spliterator.OfInt.html "interface in java.util")>`  
     Parameters:  
     `action` \- The action  
     Returns:  
     `false` if no remaining elements existed upon entry to this method, else `true`.  
     * #### forEachRemaining  
     default void forEachRemaining​([IntConsumer](../../java/util/function/IntConsumer.html "interface in java.util.function") action)  
     Performs the given action for each remaining element, sequentially in the current thread, until all elements have been processed or the action throws an exception. If this Spliterator is [Spliterator.ORDERED](../../java/util/Spliterator.html#ORDERED), actions are performed in encounter order. Exceptions thrown by the action are relayed to the caller.  
     Specified by:  
     `[forEachRemaining](../../java/util/Spliterator.OfPrimitive.html#forEachRemaining-T%5FCONS-)` in interface `[Spliterator.OfPrimitive](../../java/util/Spliterator.OfPrimitive.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang"),[IntConsumer](../../java/util/function/IntConsumer.html "interface in java.util.function"),[Spliterator.OfInt](../../java/util/Spliterator.OfInt.html "interface in java.util")>`  
     Parameters:  
     `action` \- The action  
     * #### tryAdvance  
     default boolean tryAdvance​([Consumer](../../java/util/function/Consumer.html "interface in java.util.function")<? super [Integer](../../java/lang/Integer.html "class in java.lang")> action)  
     If a remaining element exists, performs the given action on it, returning `true`; else returns `false`. If this Spliterator is [Spliterator.ORDERED](../../java/util/Spliterator.html#ORDERED) the action is performed on the next element in encounter order. Exceptions thrown by the action are relayed to the caller.  
     Specified by:  
     `[tryAdvance](../../java/util/Spliterator.html#tryAdvance-java.util.function.Consumer-)` in interface `[Spliterator](../../java/util/Spliterator.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang")>`  
     Implementation Requirements:  
     If the action is an instance of `IntConsumer` then it is cast to `IntConsumer` and passed to[tryAdvance(java.util.function.IntConsumer)](../../java/util/Spliterator.OfInt.html#tryAdvance-java.util.function.IntConsumer-); otherwise the action is adapted to an instance of `IntConsumer`, by boxing the argument of `IntConsumer`, and then passed to[tryAdvance(java.util.function.IntConsumer)](../../java/util/Spliterator.OfInt.html#tryAdvance-java.util.function.IntConsumer-).  
     Parameters:  
     `action` \- The action  
     Returns:  
     `false` if no remaining elements existed upon entry to this method, else `true`.  
     * #### forEachRemaining  
     default void forEachRemaining​([Consumer](../../java/util/function/Consumer.html "interface in java.util.function")<? super [Integer](../../java/lang/Integer.html "class in java.lang")> action)  
     Performs the given action for each remaining element, sequentially in the current thread, until all elements have been processed or the action throws an exception. If this Spliterator is [Spliterator.ORDERED](../../java/util/Spliterator.html#ORDERED), actions are performed in encounter order. Exceptions thrown by the action are relayed to the caller.  
     Specified by:  
     `[forEachRemaining](../../java/util/Spliterator.html#forEachRemaining-java.util.function.Consumer-)` in interface `[Spliterator](../../java/util/Spliterator.html "interface in java.util")<[Integer](../../java/lang/Integer.html "class in java.lang")>`  
     Implementation Requirements:  
     If the action is an instance of `IntConsumer` then it is cast to `IntConsumer` and passed to[forEachRemaining(java.util.function.IntConsumer)](../../java/util/Spliterator.OfInt.html#forEachRemaining-java.util.function.IntConsumer-); otherwise the action is adapted to an instance of `IntConsumer`, by boxing the argument of `IntConsumer`, and then passed to[forEachRemaining(java.util.function.IntConsumer)](../../java/util/Spliterator.OfInt.html#forEachRemaining-java.util.function.IntConsumer-).  
     Parameters:  
     `action` \- The action

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.