it.unimi.dsi.fastutil.chars.AbstractCharIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fastutil Show documentation

fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast access and insertion; it provides also big (64-bit) arrays, sets and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.

There is a newer version: 8.5.15

Show newest version

/* 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.chars;
/**
 * 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 AbstractCharIterator implements CharIterator {
	protected AbstractCharIterator() {
	}
	/** Delegates to the corresponding generic method. */
	public char nextChar() {
		return next().charValue();
	}
	/**
	 * Delegates to the corresponding type-specific method.
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	public Character next() {
		return Character.valueOf(nextChar());
	}
	/** 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())
			nextChar();
		return n - i - 1;
	}
}