org.abego.commons.seq.SeqForArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abego-commons-base Show documentation
There is a newer version: 1.1.0
/*
 * MIT License
 *
 * Copyright (c) 2020 Udo Borkowski, ([email protected])
 *
 * 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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.abego.commons.seq;

import org.abego.commons.lang.ArrayUtil;

import java.util.Arrays;
import java.util.Iterator;
import java.util.stream.Stream;

@SuppressWarnings("squid:S2160")
// --> 'Subclasses that add fields should override "equals"'
// (No need to override "equals" as AbstractSeq implements "equals" in an abstract way using the iterator)
final class SeqForArray extends AbstractSeq implements SeqNonEmpty {
    static final String ARRAY_MUST_NOT_BE_EMPTY_MESSAGE = "array must not be empty"; //NON-NLS

    private final T[] array;

    private SeqForArray(T[] array) {
        this.array = array;
    }

    static  SeqForArray newSeqForArray(T[] array) {
        if (array.length == 0) {
            throw new IllegalArgumentException(ARRAY_MUST_NOT_BE_EMPTY_MESSAGE);
        }
        return new SeqForArray<>(array);
    }

    @Override
    public Iterator iterator() {
        return ArrayUtil.iterator(array);
    }

    @Override
    public int size() {
        return array.length;
    }

    @Override
    public T item(int i) {
        return array[i];
    }

    @Override
    public Stream stream() {
        return Arrays.stream(array);
    }
}