Interface DoubleIterable

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      default DoubleIterator doubleIterator()
      Returns a primitive iterator on the elements of this iterable.
      default DoubleSpliterator doubleSpliterator()
      Returns a primitive spliterator on the elements of this iterable.
      default void forEach​(DoubleConsumer action)
      Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
      default void forEach​(java.util.function.Consumer<? super java.lang.Double> action)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default void forEach​(java.util.function.DoubleConsumer action)
      Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
      DoubleIterator iterator()
      Returns a type-specific iterator.
      default DoubleSpliterator spliterator()
      Returns a type-specific spliterator on the elements of this iterable.
    • Method Detail

      • iterator

        DoubleIterator iterator()
        Returns a type-specific iterator.
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.Double>
        Returns:
        a type-specific iterator.
        See Also:
        Iterable.iterator()
        API Notes:
        Note that this specification strengthens the one given in Iterable.iterator().
      • doubleIterator

        default DoubleIterator doubleIterator()
        Returns a primitive iterator on the elements of this iterable.

        This method is identical to iterator(), as the type-specific iterator is already compatible with the JDK's primitive iterators. It only exists for compatibility with the other primitive types' Iterables that have use for widened iterators.

        Returns:
        a primitive iterator on the elements of this iterable.
        Since:
        8.5.0
      • spliterator

        default DoubleSpliterator spliterator()
        Returns a type-specific spliterator on the elements of this iterable.
        Specified by:
        spliterator in interface java.lang.Iterable<java.lang.Double>
        Returns:
        a type-specific spliterator on the elements of this iterable.
        Since:
        8.5.0
        API Notes:
        Note that this specification strengthens the one given in Iterable.spliterator().
      • doubleSpliterator

        default DoubleSpliterator doubleSpliterator()
        Returns a primitive spliterator on the elements of this iterable.

        This method is identical to spliterator(), as the type-specific spliterator is already compatible with the JDK's primitive spliterators. It only exists for compatibility with the other primitive types' Iterables that have use for widened spliterators.

        Returns:
        a primitive spliterator on the elements of this collection.
        Since:
        8.5.0
      • forEach

        default void forEach​(java.util.function.DoubleConsumer action)
        Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
        Parameters:
        action - the action to be performed for each element.
        Since:
        8.0.0
        See Also:
        Iterable.forEach(java.util.function.Consumer)
        API Notes:
        Implementing classes should generally override this method, and take the default implementation of the other overloads which will delegate to this method (after proper conversions).
      • forEach

        default void forEach​(DoubleConsumer action)
        Performs the given action for each element of this type-specific Iterable 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 forEach() 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:
        Iterable.forEach(java.util.function.Consumer)
      • forEach

        @Deprecated
        default void forEach​(java.util.function.Consumer<? super java.lang.Double> action)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Specified by:
        forEach in interface java.lang.Iterable<java.lang.Double>