--- /dev/null 2013-02-14 00:07:37.184020992 -0500 +++ new/src/share/classes/java/util/stream/MatchOp.java 2013-02-21 14:11:05.000000000 -0500 @@ -0,0 +1,287 @@ +/* + * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code 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 + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +package java.util.stream; + +import java.util.Spliterator; +import java.util.function.DoublePredicate; +import java.util.function.IntPredicate; +import java.util.function.LongPredicate; +import java.util.function.Predicate; +import java.util.function.Supplier; + +/** + * A short-circuiting {@code TerminalOp} that evaluates a predicate on the elements of a stream pipeline + * and determines whether all, any, or none of the elements match a given {@code Predicate}. + * + * @param The output type of the stream pipeline + * @since 1.8 + */ +class MatchOp implements TerminalOp { + private final StreamShape inputShape; + protected final MatchKind matchKind; + protected final Supplier> sinkSupplier; + + /** + * Construct a {@code MatchOp} + * @param shape The output shape of the stream pipeline + * @param matchKind The kind of quantified match (all, any, none) + * @param sinkSupplier {@code Supplier} for a {@code Sink} of the appropriate shape which implements the + * matching operation + */ + private MatchOp(StreamShape shape, MatchKind matchKind, Supplier> sinkSupplier) { + this.inputShape = shape; + this.matchKind = matchKind; + this.sinkSupplier = sinkSupplier; + } + + // Boolean specific terminal sink to avoid the boxing costs when returning results + + /** + * Base class for match sink variants. Subclasses implement the shape-specific functionality and implement + * {@code TerminalSink}. + * @param The output type of the stream pipeline + */ + private static abstract class BooleanTerminalSink implements Sink { + protected boolean stop; + protected boolean value; + + protected BooleanTerminalSink(MatchKind matchKind) { + value = !matchKind.shortCircuitResult; + } + + public boolean getAndClearState() { + return value; + } + + @Override + public boolean cancellationRequested() { + return stop; + } + } + + /** + * Construct a {@code MatchOp} for the given predicate and quantified match criteria + * @param predicate The {@code Predicate} to apply to stream elements + * @param matchKind The kind of quantified match (all, any, none) + * @param The type of stream elements + * @return A {@code MatchOp} implementing the desired quantified match criteria + */ + public static MatchOp match(Predicate predicate, MatchKind matchKind) { + class MatchSink extends BooleanTerminalSink { + + private MatchSink() { + super(matchKind); + } + + @Override + public void accept(T t) { + // @@@ assert !stop when SortedOp supports short-circuit on Sink.end + // for sequential operations + if (!stop && predicate.test(t) == matchKind.stopOnPredicateMatches) { + stop = true; + value = matchKind.shortCircuitResult; + } + } + } + + // @@@ Change to return MatchSink::new when compiler and runtime bugs are fixed + Supplier> s = new Supplier>() { + @Override + public BooleanTerminalSink get() {return new MatchSink();} + }; + return new MatchOp<>(StreamShape.REFERENCE, matchKind, s); + } + + /** + * Construct a {@code MatchOp} for the given predicate and quantified match criteria for an {@code IntStream} + * @param predicate The {@code Predicate} to apply to stream elements + * @param matchKind The kind of quantified match (all, any, none) + * @return A {@code MatchOp} implementing the desired quantified match criteria + */ + public static MatchOp match(IntPredicate predicate, MatchKind matchKind) { + class MatchSink extends BooleanTerminalSink implements Sink.OfInt { + private MatchSink() { + super(matchKind); + } + + @Override + public void accept(int t) { + if (!stop && predicate.test(t) == matchKind.stopOnPredicateMatches) { + stop = true; + value = matchKind.shortCircuitResult; + } + } + } + + Supplier> s = new Supplier>() { + @Override + public BooleanTerminalSink get() {return new MatchSink();} + }; + return new MatchOp<>(StreamShape.INT_VALUE, matchKind, s); + } + + /** + * Construct a {@code MatchOp} for the given predicate and quantified match criteria for a {@code LongStream} + * @param predicate The {@code Predicate} to apply to stream elements + * @param matchKind The kind of quantified match (all, any, none) + * @return A {@code MatchOp} implementing the desired quantified match criteria + */ + public static MatchOp match(LongPredicate predicate, MatchKind matchKind) { + class MatchSink extends BooleanTerminalSink implements Sink.OfLong { + + private MatchSink() { + super(matchKind); + } + + @Override + public void accept(long t) { + if (!stop && predicate.test(t) == matchKind.stopOnPredicateMatches) { + stop = true; + value = matchKind.shortCircuitResult; + } + } + } + + Supplier> s = new Supplier>() { + @Override + public BooleanTerminalSink get() {return new MatchSink();} + }; + return new MatchOp<>(StreamShape.LONG_VALUE, matchKind, s); + } + + /** + * Construct a {@code MatchOp} for the given predicate and quantified match criteria for a {@code DoubleStream} + * @param predicate The {@code Predicate} to apply to stream elements + * @param matchKind The kind of quantified match (all, any, none) + * @return A {@code MatchOp} implementing the desired quantified match criteria + */ + public static MatchOp match(DoublePredicate predicate, MatchKind matchKind) { + class MatchSink extends BooleanTerminalSink implements Sink.OfDouble { + + private MatchSink() { + super(matchKind); + } + + @Override + public void accept(double t) { + if (!stop && predicate.test(t) == matchKind.stopOnPredicateMatches) { + stop = true; + value = matchKind.shortCircuitResult; + } + } + } + + Supplier> s = new Supplier>() { + @Override + public BooleanTerminalSink get() {return new MatchSink();} + }; + return new MatchOp<>(StreamShape.DOUBLE_VALUE, matchKind, s); + } + + @Override + public int getOpFlags() { + return StreamOpFlag.IS_SHORT_CIRCUIT | StreamOpFlag.NOT_ORDERED; + } + + @Override + public StreamShape inputShape() { + return inputShape; + } + + @Override + public Boolean evaluateSequential(PipelineHelper helper) { + return helper.into(sinkSupplier.get(), helper.sourceSpliterator()).getAndClearState(); + } + + @Override + public Boolean evaluateParallel(PipelineHelper helper) { + // Approach for parallel implementation: + // - Decompose as per usual + // - run match on leaf chunks, call result "b" + // - if b == matchKind.shortCircuitOn, complete early and return b + // - else if we complete normally, return !shortCircuitOn + + return new MatchTask<>(this, helper).invoke(); + } + + /** + * ForkJoinTask implementation to implement a parallel short-circuiting quantified match + * @param The type of source elements for the pipeline + * @param The type of output elements for the pipeline + */ + private static class MatchTask extends AbstractShortCircuitTask> { + private final MatchOp op; + + private MatchTask(MatchOp op, PipelineHelper helper) { + super(helper); + this.op = op; + } + + private MatchTask(MatchTask parent, Spliterator spliterator) { + super(parent, spliterator); + this.op = parent.op; + } + + @Override + protected MatchTask makeChild(Spliterator spliterator) { + return new MatchTask<>(this, spliterator); + } + + @Override + protected Boolean doLeaf() { + boolean b = helper.into(op.sinkSupplier.get(), spliterator).getAndClearState(); + if (b == op.matchKind.shortCircuitResult) + shortCircuit(b); + return null; + } + + @Override + protected Boolean getEmptyResult() { + return !op.matchKind.shortCircuitResult; + } + } + + /** + * Enum describing quantified match options -- all match, any match, none match + */ + public enum MatchKind { + /** Do all elements match the predicate? */ + ANY(true, true), + + /** Do any elements match the predicate? */ + ALL(false, false), + + /** Do no elements match the predicate? */ + NONE(true, false); + + private final boolean stopOnPredicateMatches; + private final boolean shortCircuitResult; + + private MatchKind(boolean stopOnPredicateMatches, boolean shortCircuitResult) { + this.stopOnPredicateMatches = stopOnPredicateMatches; + this.shortCircuitResult = shortCircuitResult; + } + } +}