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

Go to download
/**
 * 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;

/**
 * Captures the output written to standard out and standard error.
 *
 * @author Paul Campbell ([email protected])
 */
public interface OutputCapturer {

    /**
     * Capture the output of the callable.
     *
     * @param callable the callable to capture the output of
     *
     * @return the instance CapturedOutput
     */
    CapturedOutput of(ThrowingCallable callable);

    /**
     * Capture the output of the callable and copies to normal output.
     *
     * @param callable the callable to capture the output of
     *
     * @return the instance CapturedOutput
     */
    CapturedOutput copyOf(ThrowingCallable callable);

    /**
     * Capture the output of a running thread asynchronously.
     *
     * {@code callable} is started in a new thread.
     *
     * @param callable the callable to capture the output of
     *
     * @return an instance of OngoingCapturedOutput
     */
    OngoingCapturedOutput ofThread(ThrowingCallable callable);

    /**
     * Capture the output of the callable running asynchronously and copies to the normal output.
     *
     * {@code callable} is started in a new thread.
     *
     * @param callable the callable to capture the output of
     *
     * @return an instance of OngoingCapturedOutput
     */
    OngoingCapturedOutput copyOfThread(ThrowingCallable callable);
}