ShellResult.java

/*******************************************************************************
 * Copyright (c) 2011 Arapiki Solutions Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    "Peter Smith <psmith@arapiki.com>" - initial API and 
 *        implementation and/or initial documentation
 *******************************************************************************/ 

package com.buildml.utils.os;

/**
 * This class is used as a return value from the executeShellCmd() method. Upon return,
 * each of these fields contains the output from the process. The size of the Strings 
 * returned in this class will depend on the amount of output provided by the shell command.
 */
public class ShellResult {
	
	/*=====================================================================================*
	 * TYPES/FIELDS
	 *=====================================================================================*/

	/** The process's captured standard output. */
	private String stdout;
	
	/** The process's captured standard error. */
	private String stderr;
	
	/** The process's captured return code. */
	private int returnCode;
	
	/*=====================================================================================*
	 * CONSTRUCTORS
	 *=====================================================================================*/

	/**
	 * Create a new ShellResult object. This object reflects the output and return code
	 * from a shell command invocation.
	 * 
	 * @param stdout The text captured from the command's standard output.
	 * @param stderr The text captured from the command's standard error.
	 * @param returnCode The command's return code.
	 */
	public ShellResult(String stdout, String stderr, int returnCode) {
		this.stdout = stdout;
		this.stderr = stderr;
		this.returnCode = returnCode;
	}
	
	/*=====================================================================================*
	 * PUBLIC METHODS
	 *=====================================================================================*/
	
	/**
	 * Return the command's standard output.
	 * @return The command's standard output.
	 */
	public String getStdout() {
		return stdout;
	}
	
	/*-------------------------------------------------------------------------------------*/

	/**
	 * Return the command's standard error.
	 * @return The command's standard error
	 */
	public String getStderr() {
		return stderr;
	}
	
	/*-------------------------------------------------------------------------------------*/
	
	/**
	 * Return the command's return code.
	 * @return The command's return code
	 */
	public int getReturnCode() {
		return returnCode;
	}

	/*-------------------------------------------------------------------------------------*/
}