org.paumard.spliterators.GatingSpliterator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 José Paumard
 *
 * 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 org.paumard.spliterators;

import org.paumard.streams.StreamsUtils;

import java.util.Objects;
import java.util.Spliterator;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
import java.util.function.Predicate;

/**
 * See the documentation and patterns to be used in this class in the {@link StreamsUtils} factory class.
 *
 * @author José
 */
public class GatingSpliterator implements Spliterator {

    private final Spliterator spliterator;
    private final Predicate gate;
    private boolean hasMore = false;

    public static  GatingSpliterator of(Spliterator spliterator, Predicate gate) {
        Objects.requireNonNull(spliterator);
        Objects.requireNonNull(gate);

        return new GatingSpliterator<>(spliterator, gate);
    }

    private GatingSpliterator(Spliterator spliterator, Predicate gate) {
        this.spliterator = spliterator;
        this.gate = gate;
    }

    @Override
    public boolean tryAdvance(Consumer action) {

        return spliterator.tryAdvance(e -> {
            if (!hasMore && gate.test(e)) {
                hasMore = true;
            }
            if (hasMore) {
                action.accept(e);
            }
        });
    }

    @Override
    public Spliterator trySplit() {
        Spliterator split = this.spliterator.trySplit();
        return split == null ? null : new GatingSpliterator<>(split, gate);
    }

    @Override
    public long estimateSize() {
        if (hasMore) {
            return this.spliterator.estimateSize();
        } else {
            return 0;
        }
    }

    @Override
    public int characteristics() {
        return this.spliterator.characteristics() & ~Spliterator.SIZED & ~Spliterator.SUBSIZED;
    }
}