com.davidbracewell.stream.MPairStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mango Show documentation
A set of utilities and tools to speed up and ease programming in Java.
There is a newer version: 0.5
/*
 * (c) 2005 David B. Bracewell
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.davidbracewell.stream;

import com.davidbracewell.conversion.Cast;
import com.davidbracewell.function.*;
import com.google.common.collect.Ordering;

import java.util.List;
import java.util.Map;
import java.util.Random;

/**
 * The interface M pair stream.
 *
 * @param  the type parameter
 * @param  the type parameter
 * @author David B. Bracewell
 */
public interface MPairStream extends AutoCloseable {

  /**
   * Collect as list list.
   *
   * @return the list
   */
  List> collectAsList();

  /**
   * Collect as map map.
   *
   * @return the map
   */
  Map collectAsMap();

  /**
   * Count long.
   *
   * @return the long
   */
  long count();

  /**
   * Filter m pair stream.
   *
   * @param predicate the predicate
   * @return the m pair stream
   */
  MPairStream filter(SerializableBiPredicate predicate);

  /**
   * Filter by key m pair stream.
   *
   * @param predicate the predicate
   * @return the m pair stream
   */
  MPairStream filterByKey(SerializablePredicate predicate);

  /**
   * Filter by value m pair stream.
   *
   * @param predicate the predicate
   * @return the m pair stream
   */
  MPairStream filterByValue(SerializablePredicate predicate);

  /**
   * For each.
   *
   * @param consumer the consumer
   */
  void forEach(SerializableBiConsumer consumer);

  void forEachLocal(SerializableBiConsumer consumer);

  /**
   * Group by key m pair stream.
   *
   * @return the m pair stream
   */
  MPairStream> groupByKey();

  /**
   * Join m pair stream.
   *
   * @param     the type parameter
   * @param stream the stream
   * @return the m pair stream
   */
   MPairStream> join(MPairStream stream);

  /**
   * Keys m stream.
   *
   * @return the m stream
   */
  MStream keys();

  /**
   * Map m stream.
   *
   * @param       the type parameter
   * @param function the function
   * @return the m stream
   */
   MStream map(SerializableBiFunction function);

  /**
   * Map to pair m pair stream.
   *
   * @param       the type parameter
   * @param       the type parameter
   * @param function the function
   * @return the m pair stream
   */
   MPairStream mapToPair(SerializableBiFunction> function);

  /**
   * Reduce by key m pair stream.
   *
   * @param operator the operator
   * @return the m pair stream
   */
  MPairStream reduceByKey(SerializableBinaryOperator operator);

  /**
   * Sort by key m pair stream.
   *
   * @param ascending the ascending
   * @return the m pair stream
   */
  default MPairStream sortByKey(boolean ascending) {
    if (ascending) {
      return sortByKey((o1, o2) -> Ordering.natural().compare(Cast.as(o1), Cast.as(o2)));
    }
    return sortByKey((o1, o2) -> Ordering.natural().reversed().compare(Cast.as(o1), Cast.as(o2)));
  }

  /**
   * Sort by key m pair stream.
   *
   * @param comparator the comparator
   * @return the m pair stream
   */
  MPairStream sortByKey(SerializableComparator comparator);

  /**
   * Union m pair stream.
   *
   * @param other the other
   * @return the m pair stream
   */
  MPairStream union(MPairStream other);

  /**
   * Values m stream.
   *
   * @return the m stream
   */
  MStream values();

  /**
   * Parallel m pair stream.
   *
   * @return the m pair stream
   */
  MPairStream parallel();

  /**
   * Shuffle m stream.
   *
   * @return the m stream
   */
  default MPairStream shuffle() {
    return shuffle(new Random());
  }

  MPairStream shuffle(Random random);


}//END OF MPairStream