com.github.tommyettinger.ds.support.util.CharIterator Maven / Gradle / Ivy

Go to download

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

Making libGDX's data structures implement JDK interfaces.

The newest version!

/*
 * Copyright (c) 2013-2025 See AUTHORS file.
 *
 * 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 com.github.tommyettinger.ds.support.util;

import com.github.tommyettinger.function.CharConsumer;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * An Iterator specialized for {@code char} values.
 * This iterates over primitive chars using {@link #nextChar()}.
 * 

 * This interface is loosely based on a similar interface in OpenJDK 8.
 * This iterator interface is extremely simple and there's no way to implement it in a way
 * that respects compatibility other than the way OpenJDK 8 does.
 * OpenJDK's
 * license is available here,
 * if it applies at all.
 */
public interface CharIterator extends Iterator {
	/**
	 * Returns the next {@code char} element in the iteration.
	 *
	 * @return the next {@code char} element in the iteration
	 * @throws NoSuchElementException if the iteration has no more elements
	 */
	char nextChar ();

	/**
	 * Performs the given action for each remaining element until all elements
	 * have been processed or the action throws an exception.  Actions are
	 * performed in the order of iteration, if that order is specified.
	 * Exceptions thrown by the action are relayed to the caller.
	 *
	 * @param action The action to be performed for each element
	 * @throws NullPointerException if the specified action is null
	 * @implSpec The default implementation behaves as if:
	 * 
{@code
	 *     while (hasNext())
	 *         action.accept(nextChar());
	 * }
	 */
	default void forEachRemaining (CharConsumer action) {
		while (hasNext()) {action.accept(nextChar());}
	}

	/**
	 * {@inheritDoc}
	 *
	 * @implSpec The default implementation boxes the result of calling
	 * {@link #nextChar()}, and returns that boxed result.
	 */
	@Override
	default Character next () {
		return nextChar();
	}
}