jpa/org.eclipse.persistence.jpa.jpql/src/main/java/org/eclipse/persistence/jpa/jpql/utility/iterable/ArrayIterable.java

/*
 * Copyright (c) 2009, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.jpql.utility.iterable;

import java.util.Arrays;
import java.util.Iterator;
import org.eclipse.persistence.jpa.jpql.utility.iterator.ArrayIterator;

/**
 * An <code>ArrayIterable</code> provides an {@link Iterable}
 * for an array of objects of type <code>E</code>.
 *
 * @param <E> the type of elements returned by the iterable's iterator
 *
 * @see ArrayIterator
 * @see <a href="http://git.eclipse.org/c/dali/webtools.dali.git/tree/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/iterable/ArrayListIterable.java">ArrayListIterable</a>
 */
public class ArrayIterable<E>
    implements Iterable<E>
{
    final E[] array;
    final int start;
    final int length;

    /**
     * Construct an iterable for the specified array.
     */
    @SafeVarargs
    @SuppressWarnings({"varargs"})
    public ArrayIterable(E... array) {
        this(array, 0, array.length);
    }

    /**
     * Construct an iterable for the specified array,
     * starting at the specified start index and continuing for
     * the rest of the array.
     */
    public ArrayIterable(E[] array, int start) {
        this(array, start, array.length - start);
    }

    /**
     * Construct an iterable for the specified array,
     * starting at the specified start index and continuing for
     * the specified length.
     */
    public ArrayIterable(E[] array, int start, int length) {
        super();
        if ((start < 0) || (start > array.length)) {
            throw new IllegalArgumentException("start: " + start); //$NON-NLS-1$
        }
        if ((length < 0) || (length > array.length - start)) {
            throw new IllegalArgumentException("length: " + length); //$NON-NLS-1$
        }
        this.array = array;
        this.start = start;
        this.length = length;
    }

    @Override
    public Iterator<E> iterator() {
        return new ArrayIterator<>(this.array, this.start, this.length);
    }

    @Override
    public String toString() {
        return Arrays.toString(this.array);
    }
}