it.unimi.dsi.fastutil.booleans.AbstractBooleanIterator Maven / Gradle / Ivy
/* Generic definitions */
/* Assertions (useful to generate conditional code) */
/* Current type and class (and size, if applicable) */
/* Value methods */
/* Interfaces (keys) */
/* Interfaces (values) */
/* Abstract implementations (keys) */
/* Abstract implementations (values) */
/* Static containers (keys) */
/* Static containers (values) */
/* Implementations */
/* Synchronized wrappers */
/* Unmodifiable wrappers */
/* Other wrappers */
/* Methods (keys) */
/* Methods (values) */
/* Methods (keys/values) */
/* Methods that have special names depending on keys (but the special names depend on values) */
/* Equality */
/* Object/Reference-only definitions (keys) */
/* Primitive-type-only definitions (keys) */
/* Object/Reference-only definitions (values) */
/*
* Copyright (C) 2002-2016 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.booleans;
/**
* An abstract class facilitating the creation of type-specific iterators.
*
*
* To create a type-specific iterator you need both a method returning the next
* element as primitive type and a method returning the next element as an
* object. However, if you inherit from this class you need just one (anyone).
*
*
* This class implements also a trivial version of {@link #skip(int)} that uses
* type-specific methods; moreover, {@link #remove()} will throw an
* {@link UnsupportedOperationException}.
*
* @see java.util.Iterator
*/
public abstract class AbstractBooleanIterator implements BooleanIterator {
protected AbstractBooleanIterator() {
}
/** Delegates to the corresponding generic method. */
public boolean nextBoolean() {
return next().booleanValue();
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Boolean next() {
return Boolean.valueOf(nextBoolean());
}
/** This method just throws an {@link UnsupportedOperationException}. */
public void remove() {
throw new UnsupportedOperationException();
}
/**
* This method just iterates the type-specific version of {@link #next()}
* for at most n times, stopping if {@link #hasNext()} becomes
* false.
*/
public int skip(final int n) {
int i = n;
while (i-- != 0 && hasNext())
nextBoolean();
return n - i - 1;
}
}