net.sf.staccatocommons.io.IO Maven / Gradle / Ivy

Go to download
/**
 *  Copyright (c) 2010-2012, The StaccatoCommons 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.io;

import java.io.PrintStream;

import net.sf.staccatocommons.defs.Applicative;
import net.sf.staccatocommons.defs.Executable;
import net.sf.staccatocommons.lang.block.internal.TopLevelBlock;
import net.sf.staccatocommons.restrictions.Constant;
import net.sf.staccatocommons.restrictions.check.NonNull;
import net.sf.staccatocommons.restrictions.processing.EnforceRestrictions;

/**
 * Simple IO {@link Applicative}s
 * 
 * @author flbulgarelli
 */
public class IO {

  /**
   * Answers an {@link Executable} that prints its argument to the given
   * printStream
   * 
   * @param 
   * @param printStream
   *          the target stream
   * @return {@code print(System.out)}
   */
  @EnforceRestrictions
  public static  Executable print(@NonNull final PrintStream printStream) {
    class PrintBlock extends TopLevelBlock {
      private static final long serialVersionUID = 4013144383142068467L;

      protected void softExec(A argument) throws Exception {
        printStream.print(argument);
      };
    }
    return new PrintBlock();
  }

  /**
   * Answers an {@link Executable} that prints its argument to the standard
   * output
   * 
   * @param 
   * @return {@code print(System.out)}
   */
  @Constant
  public static  Executable printSysout() {
    return print(System.out);
  }

  /**
   * Answers an {@link Executable} that prints its argument to the standard
   * error output
   * 
   * @param 
   * @return {@code print(System.err)}
   */
  @Constant
  public static  Executable printSyserr() {
    return print(System.err);
  }

  /**
   * Answers an {@link Executable} that prints its argument, followed by a line
   * terminator, to the given printStream
   * 
   * @param 
   * @param printStream
   *          the target stream
   * @return {@code print(System.out)}
   */
  public static  Executable println(final PrintStream printStream) {
    class PrintlnBlock extends TopLevelBlock {
      private static final long serialVersionUID = 9163954134933452924L;

      protected void softExec(A argument) throws Exception {
        printStream.println(argument);
      };
    }
    return new PrintlnBlock();
  }

  /**
   * Answers an {@link Executable} that prints its argument to the standard
   * output, followed by a line terminator.
   * 
   * @param 
   * @return {@code println(System.out)}
   */
  @Constant
  public static  Executable printlnSysout() {
    return println(System.out);
  }

  /**
   * Answers an {@link Executable} that prints its argument to the standard
   * error output, followed by a line terminator.
   * 
   * @param 
   * @return {@code println(System.err)}
   */
  @Constant
  public static  Executable printlnSyserr() {
    return println(System.err);
  }

}