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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of streams-utils Show documentation

Streams Utils is a set of operations written on Java 8 Streams. It allows several basic operations that are not available in the the Java 8, and that have proven to be very useful in some cases.

There is a newer version: 2.1.1

Show newest version

/*
 * 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.Comparator;
import java.util.Objects;
import java.util.Spliterator;
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 InterruptingSpliterator implements Spliterator {

    private final Spliterator spliterator;
    private final Predicate interruptor;
    private boolean hasBeenInterrupted = false;

    public static  InterruptingSpliterator of(Spliterator spliterator, Predicate interruptor) {
        Objects.requireNonNull(spliterator);
        Objects.requireNonNull(interruptor);

        return new InterruptingSpliterator(spliterator, interruptor);
    }

    private InterruptingSpliterator(Spliterator spliterator, Predicate interruptor) {
        this.spliterator = spliterator;
        this.interruptor = interruptor;
    }

    @Override
    public boolean tryAdvance(Consumer action) {

        boolean hasMore = spliterator.tryAdvance(e -> {
            if (interruptor.test(e)) {
                hasBeenInterrupted = true;
            } else {
                action.accept(e);
            }
        });

        return hasMore && !hasBeenInterrupted;
    }

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

    @Override
    public long estimateSize() {
        return 0;
    }

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

    @Override
    public Comparator getComparator() {
        return this.spliterator.getComparator();
    }
}