net.kemitix.outputcapture.Router 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

There is a newer version: 1.0.0

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2017 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.PrintStream;

/**
 * Routes output between the capturing stream and the original stream.
 *
 * @author Paul Campbell ([email protected])
 *
 * @see {@link RedirectRouter}
 * @see {@link CopyRouter}
 */
interface Router {

    /**
     * Create an output stream that routes the output to the appropriate stream(s).
     *
     * @param capturingStream the stream capturing the output
     * @param originalStream  the stream where output would normally have gone
     * @param parentThread    The thread that invoked the output capture and the owner of the originalStream
     *
     * @return a PrintStream to be used to write to
     */
    PrintStream handle(PrintStream capturingStream, PrintStream originalStream, Thread parentThread);

}