primitive.ByteIterator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of util Show documentation
Supplementary utilities for classes that belong to java.util, or are considered essential as to justify existence in java.util.
The newest version!
/* Copyright (c) 2014 LibJ
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * You should have received a copy of The MIT License (MIT) along with this
 * program. If not, see .
 */

package org.libj.util.primitive;

import java.util.NoSuchElementException;
import java.util.Objects;

import javax.annotation.Generated;

import org.libj.util.function.ByteConsumer;

/**
 * A replica of the {@link java.util.Iterator} interface that defines synonymous
 * methods for the iteration over {@code byte} values instead of Object
 * references.
 */
@Generated(value="org.openjax.codegen.template.Templates", date="2024-02-27T13:50:20.763")
public interface ByteIterator {
  /**
   * Returns {@code true} if the iteration has more values. (In other words,
   * returns {@code true} if {@link #next} would return a value rather than
   * throwing an exception.)
   *
   * @return {@code true} if the iteration has more values.
   */
  boolean hasNext();

  /**
   * Returns the next value in the iteration.
   *
   * @return The next value in the iteration.
   * @throws NoSuchElementException If the iteration has no more values.
   */
  byte next();

  /**
   * Removes from the underlying collection the last value returned by this
   * iterator (optional operation). This method can be called only once per call
   * to {@link #next}.
   * 
   * The behavior of an iterator is unspecified if the underlying collection is
   * modified while the iteration is in progress in any way other than by
   * calling this method, unless an overriding class has specified a concurrent
   * modification policy.
   * 

   * The behavior of an iterator is unspecified if this method is called after a
   * call to the {@link #forEachRemaining(ByteConsumer)} method.
   * 

   * The default implementation throws an instance of
   * {@link UnsupportedOperationException} and performs no other action.
   *
   * @throws UnsupportedOperationException If the {@code remove} operation is
   *           not supported by this iterator.
   * @throws IllegalStateException If the {@code next} method has not yet been
   *           called, or the {@code remove} method has already been called
   *           after the last call to the {@code next} method.
   */
  default void remove() {
    throw new UnsupportedOperationException("remove");
  }

  /**
   * Performs the given action for each remaining value until all values 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.
   * 

   * The behavior of an iterator is unspecified if the action modifies the
   * collection in any way (even by calling the {@link #remove()} method or
   * other mutator methods of {@link java.util.Iterator} subtypes), unless an
   * overriding class has specified a concurrent modification policy.
   * 

   * Subsequent behavior of an iterator is unspecified if the action throws an
   * exception.
   * 

   * The default implementation behaves as if:
   *
   * 
   * {@code
   * while (hasNext())
   *   action.accept(next());
   * }
   * 
   *
   * @param action The action to be performed for each value.
   * @throws NullPointerException If the specified action is null.
   */
  default void forEachRemaining(final ByteConsumer action) {
    Objects.requireNonNull(action);
    while (hasNext())
      action.accept(next());
  }
}