io.machinecode.vial.api.OIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vial-core Show documentation

Vial Collections

The newest version!

/*
 * Copyright (C) 2015 Brent Douglas and other contributors
 * as indicated by the @author tags. All rights reserved.
 *
 * 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 io.machinecode.vial.api;

import java.util.Iterator;

/**
 * An iterator allowing navigation to specified positions in the underlying sequence.
 *
 * @author Brent Douglas
 * @since 1.0
 */
public interface OIterator extends Iterator {

  /**
   * Move this iterator to before the first item.
   *
   * @return This iterator for method chaining.
   */
  OIterator before();

  /**
   * Move this iterator to after the last item.
   *
   * @return This iterator for method chaining.
   */
  OIterator after();

  /**
   * Move this iterator to before the item at the desired index.
   *
   * @param index The index to move to.
   * @return This iterator for method chaining.
   * @throws IndexOutOfBoundsException If index is less than 0 or greater than the number of
   *     elements in the underlying collection.
   */
  OIterator index(final int index) throws IndexOutOfBoundsException;
}