drv.Iterable.drv Maven / Gradle / Ivy
Show all versions of fastutil-core Show documentation
/*
* Copyright (C) 2002-2022 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.lang.Iterable;
#if KEYS_PRIMITIVE
import java.util.Objects;
import java.util.function.Consumer;
#if KEYS_BYTE_CHAR_SHORT_FLOAT
import WIDENED_PACKAGE.KEY_WIDENED_ITERATOR;
import WIDENED_PACKAGE.WIDENED_ITERATORS;
import WIDENED_PACKAGE.KEY_WIDENED_SPLITERATOR;
import WIDENED_PACKAGE.WIDENED_SPLITERATORS;
#endif
/** A type-specific {@link Iterable} that strengthens that specification of {@link #iterator()} and {@link #forEach(Consumer)}.
*
* Note that whenever there exist a primitive consumer in {@link java.util.function} (e.g., {@link java.util.function.IntConsumer}),
* trying to access any version of {@link #forEach(Consumer)} using a lambda expression with untyped arguments
* will generate an ambiguous method error. This can be easily solved by specifying the type of the argument, as in
*
* intIterable.forEach((int x) -> { // Do something with x });
*
* The same problem plagues, for example, {@link java.util.PrimitiveIterator.OfInt#forEachRemaining(java.util.function.IntConsumer)}.
*
*
Warning: Java will let you write “colon” {@code for} statements with primitive-type
* loop variables; however, what is (unfortunately) really happening is that at each iteration an
* unboxing (and, in the case of {@code fastutil} type-specific data structures, a boxing) will be performed. Watch out.
*
* @see Iterable
*/
#else // !KEYS_PRIMITIVE
/** A type-specific {@link Iterable} that strengthens that specification of {@link #iterator()}.
*
* @see Iterable
*/
#endif
public interface KEY_ITERABLE KEY_GENERIC extends Iterable {
/** Returns a type-specific iterator.
*
* @apiNote Note that this specification strengthens the one given in {@link Iterable#iterator()}.
*
* @return a type-specific iterator.
* @see Iterable#iterator()
*/
@Override
KEY_ITERATOR KEY_GENERIC iterator();
#if KEYS_PRIMITIVE && !KEY_CLASS_Boolean
#if KEYS_INT_LONG_DOUBLE
/** Returns a primitive iterator on the elements of this iterable.
*
* This method is identical to {@link #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' {@code Iterable}s
* that have use for widened iterators.
*
* @return a primitive iterator on the elements of this iterable.
* @since 8.5.0
*/
default KEY_WIDENED_ITERATOR KEY_WIDENED_ITERATOR_METHOD() { return iterator(); }
#else
#if KEY_CLASS_Character
/**
* Returns a widened primitive iterator on the elements of this iterable.
*
* This method is provided for the purpose of APIs that expect only the JDK's
* primitive iterators, of which there are only {@code int}, {@code long}, and {@code double}.
*
*
WARNING: This is not the same as converting the source to a sequence
* of code points. This returned instance literally performs {@code (int)(charValue)} casts.
* Surrogate pairs will be left as separate elements instead of combined into a single element
* with the code point it represents. See {@link Character} for more discussion on code points,
* char values, and surrogate pairs.
*
* @return a widened primitive iterator on the elements of this iterable.
* @since 8.5.0
*/
#else
/**
* Returns a widened primitive iterator on the elements of this iterable.
*
* This method is provided for the purpose of APIs that expect only the JDK's
* primitive iterators, of which there are only {@code int}, {@code long}, and {@code double}.
*
* @return a widened primitive iterator on the elements of this iterable.
* @since 8.5.0
*/
#endif
default KEY_WIDENED_ITERATOR KEY_WIDENED_ITERATOR_METHOD() {
return WIDENED_ITERATORS.wrap(iterator());
}
#endif
#endif
// If you change these default spliterator methods, you will likely need to update Collection, List, Set, and SortedSet too.
/** Returns a type-specific spliterator on the elements of this iterable.
*
* @apiNote Note that this specification strengthens the one given in
* {@link java.lang.Iterable#spliterator()}.
*
* @return a type-specific spliterator on the elements of this iterable.
* @since 8.5.0
*/
@Override
#if SPLITERATOR_ASSURE_OVERRIDE
abstract KEY_SPLITERATOR KEY_GENERIC spliterator();
#else
default KEY_SPLITERATOR KEY_GENERIC spliterator() {
return SPLITERATORS.asSpliteratorUnknownSize(iterator(), 0);
}
#endif
#if KEYS_PRIMITIVE
#if !KEY_CLASS_Boolean
#if KEYS_INT_LONG_DOUBLE
/** Returns a primitive spliterator on the elements of this iterable.
*
* This method is identical to {@link #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' {@code Iterable}s
* that have use for widened spliterators.
*
* @return a primitive spliterator on the elements of this collection.
* @since 8.5.0
*/
default KEY_WIDENED_SPLITERATOR KEY_WIDENED_SPLITERATOR_METHOD() { return spliterator(); }
#else
#if KEY_CLASS_Character
/** Returns widened primitive spliterator on the elements of this iterable.
*
* This method is provided for the purpose of APIs that expect only the JDK's
* primitive spliterators, of which there are only {@code int}, {@code long}, and {@code double}.
*
*
WARNING: This is not the same as converting the source to a sequence
* of code points. This returned instance literally performs {@code (int)(charValue)} casts.
* Surrogate pairs will be left as separate elements instead of combined into a single element
* with the code point it represents. See {@link Character} for more discussion on code points,
* char values, and surrogate pairs.
*
* @implSpec The default implementation widens the spliterator from {@link #spliterator()}.
* @return a widened primitive spliterator on the elements of this iterable.
* @since 8.5.0
*/
#else
/** Returns widened primitive spliterator on the elements of this iterable.
*
* This method is provided for the purpose of APIs that expect only the JDK's
* primitive spliterators, of which there are only {@code int}, {@code long}, and {@code double}.
*
* @implSpec The default implementation widens the spliterator from {@link #spliterator()}.
* @return a widened primitive spliterator on the elements of this iterable.
* @since 8.5.0
*/
#endif
default KEY_WIDENED_SPLITERATOR KEY_WIDENED_SPLITERATOR_METHOD() {
return WIDENED_SPLITERATORS.wrap(spliterator());
}
#endif
#endif
/**
* Performs the given action for each element of this type-specific {@link java.lang.Iterable}
* until all elements have been processed or the action throws an
* exception.
*
* @param action the action to be performed for each element.
* @see java.lang.Iterable#forEach(java.util.function.Consumer)
* @since 8.0.0
* @apiNote 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).
*/
default void forEach(final METHOD_ARG_KEY_CONSUMER action) {
Objects.requireNonNull(action);
iterator().forEachRemaining(action);
}
#if KEYS_INT_LONG_DOUBLE
// Because our primitive Consumer interface extends both the JDK's primitive
// and object Consumer interfaces, calling this method with it would be ambiguous.
// This overload exists to pass it to the proper primitive overload.
/**
* Performs the given action for each element of this type-specific {@link java.lang.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 {@code forEach()} overload
* that uses the JDK's primitive consumer type (e.g. {@link java.util.function.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 {@code 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.
*
* @param action the action to be performed for each element.
* @see java.lang.Iterable#forEach(java.util.function.Consumer)
* @since 8.5.0
*/
default void forEach(final KEY_CONSUMER action) {
forEach((JDK_PRIMITIVE_KEY_CONSUMER) action);
}
#elif KEYS_BYTE_CHAR_SHORT_FLOAT
/**
* Performs the given action for each element of this type-specific {@link java.lang.Iterable},
* performing widening primitive casts, until all elements have been processed or the action
* throws an exception.
*
* @param action the action to be performed for each element.
* @see java.lang.Iterable#forEach(java.util.function.Consumer)
* @since 8.0.0
* @implNote Unless the argument is type-specific, this method will introduce an intermediary
* lambda to perform widening casts. Please use the type-specific overload to avoid this overhead.
*/
default void forEach(final JDK_PRIMITIVE_KEY_CONSUMER action) {
Objects.requireNonNull(action);
forEach(action instanceof KEY_CONSUMER ? (KEY_CONSUMER)action : (KEY_CONSUMER)action::accept);
}
#endif
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
default void forEach(final Consumer action) {
Objects.requireNonNull(action);
// The instanceof and cast is required for performance. Without it, calls routed through this
// overload using a primitive consumer would go through the slow lambda.
forEach(action instanceof METHOD_ARG_KEY_CONSUMER ? (METHOD_ARG_KEY_CONSUMER)action : (METHOD_ARG_KEY_CONSUMER) action::accept);
}
#endif
}