net.sf.staccatocommons.collections.stream.Crossable Maven / Gradle / Ivy

Go to download
/*
 Copyright (c) 2011, The Staccato-Commons Team

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
 the Free Software Foundation; version 3 of the License.

 This program 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 Lesser General Public License for more details.
 */
package net.sf.staccatocommons.collections.stream;

import net.sf.staccatocommons.collections.iterable.Iterables;
import net.sf.staccatocommons.collections.restrictions.Projection;
import net.sf.staccatocommons.defs.tuple.Tuple2;
import net.sf.staccatocommons.restrictions.check.NonNull;

/**
 * {@link Stream} interface for crossing streams (performing Cartesian product
 * of elements)
 * 
 * @author flbulgarelli
 * 
 */
public interface Crossable {

  /**
   * Answers the Cartesian product of this stream and itself
   * 
   * @param other
   * @return a new {@link Stream} projection
   * @see Iterables#cross(Iterable, Iterable)
   */
  @Projection
  Stream> cross();

  /**
   * Answers the Cartesian product of this stream and the given one
   * 
   * @param 
   * @param other
   * @return a new {@link Stream} projection
   * @see Iterables#cross(Iterable, Iterable)
   */
  @Projection
   Stream> cross(@NonNull Stream other);

  /**
   * Answers the cartesian product of this {@link Stream} and the given
   * {@link Iterable}
   * 
   * @param 
   * @param other
   * @return cross(Streams.from(other))
   * @see #cross(Stream)
   */
  @Projection
   Stream> cross(@NonNull Iterable other);

  /**
   * Answers the cartesian product of this {@link Stream} and each one of the
   * given streamOfStreams
   * 
   * @param streamOfStreams
   * @return a new {@link Stream} projection
   */
  @Projection
  Stream> crossStreams(@NonNull Stream> streamOfStreams);

}