nucleus/common/simple-glassfish-api/src/main/java/org/glassfish/embeddable/CommandResult.java

/*
 * Copyright (c) 2009, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.embeddable;

/**
 * Encapsulates the result of a command invoked using {@link CommandRunner#run}.
 *
 * @author Sanjeeb.Sahoo@Sun.COM
 */
public interface CommandResult {
    /**
     * A command can have following types of exit status.
     */
    enum ExitStatus {
        SUCCESS,
        WARNING,
        FAILURE
    }

    /**
     * @return exit status of the command
     */
    ExitStatus getExitStatus();

    /**
     * @return command output
     */
    String getOutput();

    /**
     * This method returns any exception raised during command invocation, If the command's exit status
     * is {@link ExitStatus#SUCCESS}, then this method will return null.
     *
     * @return any exception that occurred during this command execution.
     */
    Throwable getFailureCause();
}