ProcessExecutorResults.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation, and/or the GNU Lesser
 * General Public License, version 2.1, also as published by the Free
 * Software Foundation.
 *
 * 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 General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.rhq.core.util.exec;

/**
 * The results of a process execution.
 *
 * @author John Mazzitelli
 * @see    ProcessExecutor
 * @see    ProcessToStart
 */
public class ProcessExecutorResults {
    private Integer exitCode;
    private Throwable error;
    private Process process;

    /**
     * The exit code of the process. Note that if the {@link ProcessToStart} did not want to wait for the process to
     * exit, the returned value will be <code>null</code>. The returned value will also be <code>null</code> if the
     * process failed to start; in which case, you can get the {@link #getError()} that caused the failure.
     *
     * @return the exit code of the process; <code>null</code> if the process failed to start or the we didn't wait for
     *         the process to exit
     */
    public Integer getExitCode() {
        return exitCode;
    }

    public void setExitCode(Integer code) {
        exitCode = code;
    }

    /**
     * If the process failed to start, this will indicate the error that occurred.
     *
     * @return start error (may be <code>null</code> if the process started successfully)
     */
    public Throwable getError() {
        return error;
    }

    public void setError(Throwable t) {
        error = t;
    }

    /**
     * @return The spawned Process. typically used only to destroy the process, if necessary.
     */
    public Process getProcess() {
        return process;
    }

    public void setProcess(Process process) {
        this.process = process;
    }

    public String toString() {
        return "ProcessExecResults: exit-code=[" + exitCode + "], error=[" + error + "]";
    }
}