/*
* Copyright (C) 2002-2019 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 it.unimi.dsi.fastutil.objects;
import java.util.Iterator;
A type-specific Iterator
; provides an additional method to avoid (un)boxing, and the possibility to skip elements. See Also:
/**
* A type-specific {@link Iterator}; provides an additional method to avoid
* (un)boxing, and the possibility to skip elements.
*
* @see Iterator
*/
public interface ObjectIterator<K> extends Iterator<K> {
Skips the given number of elements.
The effect of this call is exactly the same as that of calling Iterator.next()
for n
times (possibly stopping if Iterator.hasNext()
becomes false).
Params: - n –
the number of elements to skip.
See Also: Returns: the number of elements actually skipped.
/**
* Skips the given number of elements.
*
* <p>
* 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();
return n - i - 1;
}
}