io.baratine.stream.ResultStreamBuilderSync Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine 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 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package io.baratine.stream;

import io.baratine.function.BiConsumerSync;
import io.baratine.function.BiFunctionSync;
import io.baratine.function.BinaryOperatorSync;
import io.baratine.function.ConsumerAsync;
import io.baratine.function.ConsumerSync;
import io.baratine.function.FunctionAsync;
import io.baratine.function.FunctionSync;
import io.baratine.function.PredicateAsync;
import io.baratine.function.PredicateSync;
import io.baratine.function.SupplierSync;

import java.util.stream.Stream;

/**
 * ResultStream builder that allows for blocking terminal calls.
 */
public interface ResultStreamBuilderSync extends ResultStreamBuilder
{
  //
  // terminals
  //
  
  T result();
  
  // foreach

  @Override
  ResultStreamBuilderSync forEach(ConsumerSync consumer);
  
  @Override
  ResultStreamBuilderSync forEach(ConsumerAsync consumer);
  
  @Override
  ResultStreamBuilderSync first();
  
  @Override
  ResultStreamBuilderSync ignore();
  
  /**
   * Reduce with a binary function
   * 
   * 
   * s = t1;
   * s = op(s, t2);
   * s = op(s, t3);
   * result = s;
   * 
   */
  @Override
  ResultStreamBuilderSync reduce(BinaryOperatorSync op);
  
  /**
   * Reduce with a binary function and an initial value
   * 
   * 
   * s = init;
   * s = op(s, t1);
   * s = op(s, t2);
   * result = s;
   * 
   */
  @Override
  ResultStreamBuilderSync reduce(T init, 
                                BinaryOperatorSync op);
  
  @Override
   ResultStreamBuilderSync 
  reduce(R identity, 
         BiFunctionSync accumulator,
         BinaryOperatorSync combiner);
  
  @Override
   ResultStreamBuilderSync
  collect(SupplierSync init,
          BiConsumerSync accum,
          BiConsumerSync combiner);
  
  //
  // map/filter
  //
  
  @Override
   ResultStreamBuilderSync map(FunctionSync map);

  @Override
   ResultStreamBuilderSync map(FunctionAsync map);
  
  @Override
  ResultStreamBuilderSync filter(PredicateSync test);
  
  @Override
  ResultStreamBuilderSync filter(PredicateAsync test);
  
  //
  //
  //

  @Override
   ResultStreamBuilderSync custom(FunctionSync,ResultStream> factory);

  @Override
  ResultStreamBuilderSync peek(ConsumerSync consumer);
  
  @Override
  ResultStreamBuilderSync local();
  
  // StreamBuilder prefetch(int prefetch);
  
  @Override
  ResultStreamBuilderSync> iter();
  
  @Override
  ResultStreamBuilderSync> stream();
}