net.kemitix.outputcapture.CapturedOutput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of output-capture Show documentation

Capture output written to System.out and System.err

The newest version!

/*
  The MIT License (MIT)

  Copyright (c) 2018 Paul Campbell

  Permission is hereby granted, free of charge, to any person obtaining a copy of this software
  and associated documentation files (the "Software"), to deal in the Software without restriction,
  including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
  subject to the following conditions:

  The above copyright notice and this permission notice shall be included in all copies
  or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
  AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package net.kemitix.outputcapture;

import java.io.ByteArrayOutputStream;
import java.util.stream.Stream;

/**
 * The output that was written to {@code System.out} and {@code System.err}.
 *
 * @author Paul Campbell ([email protected])
 */
public interface CapturedOutput {

    /**
     * Get a stream of the captured standard output so far.
     *
     * @return a Stream of Strings, one line per String using the system's line separator
     */
    Stream getStdOut();

    /**
     * Get a stream of the captured standard error so far.
     *
     * @return a Stream of Strings, one line per String using the system's line separator
     */
    Stream getStdErr();

    /**
     * The captured standard output.
     *
     * @return an OutputStream
     */
    ByteArrayOutputStream out();

    /**
     * The captured standard error.
     *
     * @return an OutputStream
     */
    ByteArrayOutputStream err();

    /**
     * Fetch all the captured lines as a stream.
     *
     * @return a Stream of CapturedOutputLines
     */
    Stream stream();

}