drv.Iterator.drv Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fastutil Show documentation
Show all versions of fastutil Show documentation
fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists and priority queues with a small memory footprint and fast access and insertion; provides also big (64-bit) arrays, sets and lists, and fast, practical I/O classes for binary and text files.
/*
* Copyright (C) 2002-2017 Sebastiano Vigna
*
* 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 PACKAGE;
import java.util.Iterator;
#if defined JDK_PRIMITIVE_ITERATOR && !KEY_WIDENED
import java.util.PrimitiveIterator;
#endif
#if (!defined JDK_PRIMITIVE_ITERATOR || KEY_WIDENED) && KEYS_PRIMITIVE
import java.util.Objects;
#endif
#ifdef KEYS_PRIMITIVE
import java.util.function.Consumer;
#endif
/** A type-specific {@link Iterator}; provides an additional method to avoid (un)boxing, and
* the possibility to skip elements.
*
* @see Iterator
*/
#if defined JDK_PRIMITIVE_ITERATOR && !KEY_WIDENED
public interface KEY_ITERATOR KEY_GENERIC extends JDK_PRIMITIVE_ITERATOR {
#else
public interface KEY_ITERATOR KEY_GENERIC extends Iterator {
#endif
#if KEYS_PRIMITIVE
/**
* Returns the next element as a primitive type.
*
* @return the next element in the iteration.
* @see Iterator#next()
*/
#if defined JDK_PRIMITIVE_ITERATOR && !KEY_WIDENED
@Override
#endif
KEY_TYPE NEXT_KEY();
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default KEY_CLASS next() {
return KEY_CLASS.valueOf(NEXT_KEY());
}
#if !defined JDK_PRIMITIVE_ITERATOR || KEY_WIDENED
/**
* Performs the given action for each remaining element until all elements
* have been processed or the action throws an exception.
* @param action the action to be performed for each element.
* @see java.util.Iterator#forEachRemaining(java.util.function.Consumer)
* @since 8.0.0
*/
default void forEachRemaining(final KEY_CONSUMER action) {
Objects.requireNonNull(action);
while (hasNext()) {
action.accept(NEXT_KEY());
}
}
#endif
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default void forEachRemaining(final Consumer action) {
#if defined JDK_PRIMITIVE_ITERATOR && !KEY_WIDENED
forEachRemaining((JDK_PRIMITIVE_KEY_CONSUMER) action::accept);
#else
forEachRemaining((KEY_CONSUMER) action::accept);
#endif
}
#endif
/** Skips the given number of elements.
*
* The effect of this call is exactly the same as that of calling {@link #next()} for {@code n} times (possibly stopping if {@link #hasNext()} becomes false).
*
* @param n the number of elements to skip.
* @return the number of elements actually skipped.
* @see Iterator#next()
*/
default int skip(final int n) {
if (n < 0) throw new IllegalArgumentException("Argument must be nonnegative: " + n);
int i = n;
while(i-- != 0 && hasNext()) NEXT_KEY();
return n - i - 1;
}
}