org.neo4j.collection.ResourceRawIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-collections Show documentation

Collections and collection utilities for Neo4j.

There is a newer version: 5.25.1

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.collection;

import java.util.NoSuchElementException;
import org.neo4j.function.ThrowingSupplier;
import org.neo4j.graphdb.Resource;

/** A {@link RawIterator} with resources. */
public interface ResourceRawIterator extends RawIterator, Resource {

    ResourceRawIterator EMPTY_ITERATOR = ResourceRawIterator.of();

    @SuppressWarnings("unchecked")
    static  ResourceRawIterator empty() {
        return (ResourceRawIterator) EMPTY_ITERATOR;
    }

    static  ResourceRawIterator of(T... values) {
        return new ResourceRawIterator<>() {
            private int position;

            @Override
            public boolean hasNext() {
                return position < values.length;
            }

            @Override
            public T next() {
                if (hasNext()) {
                    return values[position++];
                }
                throw new NoSuchElementException();
            }

            @Override
            public void close() {}
        };
    }

    /**
     * Create a raw iterator from the provided {@link ThrowingSupplier} - the iterator will end
     * when the supplier returns null.
     */
    static  ResourceRawIterator from(ThrowingSupplier supplier) {
        return new AbstractPrefetchingRawIterator<>() {
            @Override
            protected T fetchNextOrNull() throws EX {
                return supplier.get();
            }

            @Override
            public void close() {}
        };
    }
}