net.openhft.koloboke.collect.DoubleIterator Maven / Gradle / Ivy

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.openhft.koloboke.collect;

import java.util.function.DoubleConsumer;
import java.util.function.Consumer;

import javax.annotation.Nonnull;
import java.util.Iterator;


/**
 * Primitive specialization of {@link Iterator}<{@link Double}>.
 *
 * See the comparison of iteration ways
 * in the library.
 *
 * Iterators of updatable and immutable collections don't support {@link #remove()}
 * operation. More about mutability profiles.
 * 
 *
 * @see DoubleCollection#iterator()
 */
public interface DoubleIterator extends Iterator
        , java.util.PrimitiveIterator.OfDouble {

    /**
     * Returns the next {@code double} element in the iteration. This is a primitive specialization
     * of the {@link #next()} method.
     *
     * @return the next {@code double} element in the iteration
     * @throws java.util.NoSuchElementException if the iteration has no more elements
     */
    @Override
    double nextDouble();

    /**
     * Performs the given action for each remaining element until all elements
     * have been processed or the action throws an exception.  Actions are
     * performed in the order of iteration, if that order is specified.
     * Exceptions thrown by the action are relayed to the caller.
     *
     * @param action the action to be performed for each element
     * @deprecated Use specialization {@link #forEachRemaining(DoubleConsumer)} instead
     */
    @Override
    @Deprecated
    void forEachRemaining(@Nonnull Consumer action);

    /**
     * Performs the given action for each remaining element until all elements
     * have been processed or the action throws an exception.  Actions are
     * performed in the order of iteration, if that order is specified.
     * Exceptions thrown by the action are relayed to the caller.
     *
     * @param action the action to be performed for each element
     */
    @Override
    void forEachRemaining(@Nonnull DoubleConsumer action);

}