net.sf.staccatocommons.collections.stream.Interscalable 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.restrictions.Projection;
import net.sf.staccatocommons.defs.function.Function;
import net.sf.staccatocommons.restrictions.check.NonNull;

/**
 * Interface for interscalating elements in a stream
 * 
 * @author flbulgarelli
 * 
 */
public interface Interscalable {

  /**
   * Inserts the given element between each retrieved element of
   * this {@link Stream}
   * 
   * @param element
   * @return a new {@link Stream}
   */
  @Projection
  Stream intersperse(A element);

  /**
   * Inserts after each element the result of applying the given function to it. 
   * For example:
   * 
   *    *    Streams.cons(10, 9, 90).incorporate(integer().negate()).equiv(10,-10,9,-9,90,-90);
   * 
   * 
   * @param function
   * @return a new {@link Stream}
   * @since 1.2
   */
  @Projection
  Stream incorporate(@NonNull Function function);

  /**
   * Inserts the given value after each element of the stream.
   * 
   * This message is similar to {@link #intersperse(Object)}, 
   * but inserts the value also at the end of the stream.  
   * @param element
   * Example: 
   * 
   *    *    Streams.cons('a', 'b', 'c').incorporate('d').equiv('a', 'd', 'b', 'd','c', 'd');
   * 
   * 
   * @return a new {@link Stream}
   * @since 1.2
   */
  @Projection
  Stream incorporate(@NonNull A element);

}