netbeans/jemmy/TestOut.java

/*
 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.netbeans.jemmy;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.io.PrintWriter;

/**
 *
 * Test output.
 *
 * @author Alexandre Iline (alexandre.iline@oracle.com)
 */
public class TestOut {

    private InputStream input;
    private PrintWriter output;
    private PrintWriter errput;
    private PrintWriter golden_output;
    private BufferedReader buffInput;
    private boolean autoFlushMode = true;

    /**
     * Constructor.
     *
     * @param in Input stream
     * @param out Output stream
     * @param err Errput stream
     */
    public TestOut(InputStream in, PrintStream out, PrintStream err) {
        this(in, out, err, null);
    }

    /**
     * Constructor.
     *
     * @param in Input stream
     * @param out Output stream
     * @param err Errput stream
     * @param golden Golgen output stream
     */
    public TestOut(InputStream in, PrintStream out, PrintStream err, PrintStream golden) {
        super();
        PrintWriter tout = null;
        if (out != null) {
            tout = new PrintWriter(out);
        }
        PrintWriter terr = null;
        if (err != null) {
            terr = new PrintWriter(err);
        }
        PrintWriter tgolden = null;
        if (golden != null) {
            tgolden = new PrintWriter(golden);
        }
        initStreams(in, tout, terr, tgolden);
    }

    /**
     * Constructor.
     *
     * @param in Input stream
     * @param out Output stream
     * @param err Errput stream
     */
    public TestOut(InputStream in, PrintWriter out, PrintWriter err) {
        this(in, out, err, null);
    }

    /**
     * Constructor.
     *
     * @param in Input stream
     * @param out Output stream
     * @param err Errput stream
     * @param golden Golgen output stream
     */
    public TestOut(InputStream in, PrintWriter out, PrintWriter err, PrintWriter golden) {
        super();
        initStreams(in, out, err, golden);
        autoFlushMode = true;
    }

    /**
     * Creates unstance using System.in, System.out and System.err streams.
     */
    public TestOut() {
        this(System.in,
                new PrintWriter(System.out),
                new PrintWriter(System.err),
                null);
    }

    /**
     * Creates output which does not print any message anywhere.
     *
     * @return a TestOut object which does not print any message anywhere.
     */
    public static TestOut getNullOutput() {
        return new TestOut((InputStream) null, (PrintWriter) null, (PrintWriter) null);
    }

    /**
     * Specifies either flush is invoked after each output.
     *
     * @param autoFlushMode If true flush is invoking after each output.
     * @return Old value of the auto flush mode.
     * @see #getAutoFlushMode
     */
    public boolean setAutoFlushMode(boolean autoFlushMode) {
        boolean oldValue = getAutoFlushMode();
        this.autoFlushMode = autoFlushMode;
        return oldValue;
    }

    /**
     * Says if flush is invoked after each output.
     *
     * @return Value of the auto flush mode.
     * @see #setAutoFlushMode
     */
    public boolean getAutoFlushMode() {
        return autoFlushMode;
    }

    /**
     * Read one byte from input.
     *
     * @return an int from input stream.
     * @exception IOException
     */
    public int read() throws IOException {
        if (input != null) {
            return input.read();
        } else {
            return -1;
        }
    }

    /**
     * Read a line from input.
     *
     * @return a line from input stream.
     * @exception IOException
     */
    public String readLine() throws IOException {
        if (buffInput != null) {
            return buffInput.readLine();
        } else {
            return null;
        }
    }

    /**
     * Prints a line into output.
     *
     * @param line a string to print into output stream.
     */
    public void print(String line) {
        if (output != null) {
            output.print(line);
        }
    }

    /**
     * Prints a line and then terminate the line by writing the line separator
     * string.
     *
     * @param line a string to print into output stream.
     */
    public void printLine(String line) {
        if (output != null) {
            output.println(line);
            if (autoFlushMode) {
                output.flush();
            }
        }
    }

    /**
     * Prints a line into golden output.
     *
     * @param line a string to print into golden output stream.
     */
    public void printGolden(String line) {
        if (golden_output != null) {
            golden_output.println(line);
            if (autoFlushMode) {
                golden_output.flush();
            }
        }
    }

    /**
     * Prints a line into error output.
     *
     * @param line a string to print into error output stream.
     */
    public void printErrLine(String line) {
        if (errput != null) {
            errput.println(line);
            if (autoFlushMode) {
                errput.flush();
            }
        }
    }

    /**
     * Prints a line into either output or errput.
     *
     * @param toOut If true prints a line into output.
     * @param line a string to print.
     */
    public void printLine(boolean toOut, String line) {
        if (toOut) {
            printLine(line);
        } else {
            printErrLine(line);
        }
    }

    /**
     * Prints a trace line.
     *
     * @param text a trace text.
     */
    public void printTrace(String text) {
        printLine("Trace:");
        printLine(text);
    }

    /**
     * Prints a error line.
     *
     * @param text a error text.
     */
    public void printError(String text) {
        printErrLine("Error:");
        printErrLine(text);
    }

    /**
     * Prints an exception stack trace into error stream.
     *
     * @param e exception
     */
    public void printStackTrace(Throwable e) {
        if (errput != null) {
            e.printStackTrace(errput);
            if (autoFlushMode) {
                errput.flush();
            }
        }
    }

    /**
     * Returns input stream.
     *
     * @return an input stream
     */
    public InputStream getInput() {
        return input;
    }

    /**
     * Returns output writer.
     *
     * @return an output stream
     */
    public PrintWriter getOutput() {
        return output;
    }

    /**
     * Returns errput writer.
     *
     * @return a error stream
     */
    public PrintWriter getErrput() {
        return errput;
    }

    /**
     * Returns golden output writer.
     *
     * @return a golden output stream
     */
    public PrintWriter getGolden() {
        return golden_output;
    }

    /**
     * Creates an output which prints only error messages.
     *
     * @return a TestOut instance which has only error stream.
     */
    public TestOut createErrorOutput() {
        return new TestOut(null, null, getErrput());
    }

    /**
     * Flushes all output threads.
     */
    public void flush() {
        if (output != null) {
            output.flush();
        }
        if (errput != null) {
            errput.flush();
        }
        if (golden_output != null) {
            golden_output.flush();
        }
    }

    private void initStreams(InputStream in, PrintWriter out, PrintWriter err, PrintWriter golden) {
        input = in;
        output = out;
        errput = err;
        golden_output = golden;
        if (input != null) {
            buffInput = new BufferedReader(new InputStreamReader(in));
        } else {
            buffInput = null;
        }
    }
}