com.alanbuttars.commons.cli.response.CommandLineResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-cli Show documentation
Commons CLI is an API for simplifying the deployment and evaluation of command line processes.
The newest version!
/*
 * Copyright (C) Alan Buttars
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.alanbuttars.commons.cli.response;

import com.alanbuttars.commons.cli.util.EvaluationResult;

/**
 * Models a command line {@link Process} result. This object may be evaluated in the following manner: 

 *
 *  * CommandLineResponse response = Processes.execute(request);
 * if (response.succeeded()) {
 * 	String infoStream = response.getInfoStream();
 * 	String[] infoStreamLines = infoStream.split("\n");
 * 	// examine info stream lines however you like
 * }
 * else if (response.failed()) {
 * 	if (response.interrupted()) {
 * 		InterruptedException exception = (InterruptedException) response.getException();
 * 		throw exception;
 * 	}
 * 	else if (response.exceptionThrown()) {
 * 		IOException exception = (IOException) response.getException();
 * 		throw exception;
 * 	}
 * 	else {
 * 		int exitCode = response.getExitCode();
 * 		String errorStream = response.getErrorStream();
 * 		String[] errorStreamLines = errorStream.split("\n");
 * 		// examine error stream lines however you like
 * 	}
 * }
 * else { // non-conclusive
 * 	String infoStream = response.getInfoStream();
 * 	String[] infoStreamLines = infoStream.split("\n");
 * 	// examine info stream lines however you like
 * 
 * 	String errorStream = response.getErrorStream();
 * 	String[] errorStreamLines = errorStream.split("\n");
 * 	// examine error stream lines however you like
 * }
 * 
 *
 * @author Alan Buttars
 *
 */
public class CommandLineResponse extends EvaluationResult {

	public static final int EXCEPTION_THROWN_EXIT_CODE = Integer.MIN_VALUE;
	public static final int INTERRUPTED_BEFORE_COMPLETION_EXIT_CODE = Integer.MAX_VALUE;
	private int exitCode;
	private String infoStream;
	private String errorStream;
	private Exception exception;

	public void setExitCode(int exitCode) {
		this.exitCode = exitCode;
	}

	/**
	 * @return the process's exit status
	 */
	public int getExitCode() {
		return exitCode;
	}

	public void setInfoStream(String infoStream) {
		this.infoStream = infoStream;
	}

	/**
	 * @return the process's info stream
	 */
	public String getInfoStream() {
		return infoStream;
	}

	public void setErrorStream(String errorStream) {
		this.errorStream = errorStream;
	}

	/**
	 * @return the process's error stream
	 */
	public String getErrorStream() {
		return errorStream;
	}

	public void setException(Exception exception) {
		this.exception = exception;
	}

	/**
	 * @return null if the process executed cleanly
	 */
	public Exception getException() {
		return exception;
	}

	public boolean exceptionThrown() {
		return exitCode == EXCEPTION_THROWN_EXIT_CODE;
	}

	public boolean interrupted() {
		return exitCode == INTERRUPTED_BEFORE_COMPLETION_EXIT_CODE;
	}

}