org.zeroturnaround.exec.ProcessResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of zt-exec Show documentation
A lightweight library to execute external processes from Java.
The newest version!
/*
 * Copyright (C) 2014 ZeroTurnaround 
 * Contains fragments of code from Apache Commons Exec, rights owned
 * by Apache Software Foundation (ASF).
 *
 * 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 org.zeroturnaround.exec;

/**
 * Exit value and output of a finished process.
 *
 * @author Rein Raudjärv
 * @see ProcessExecutor
 */
public class ProcessResult {

  /**
   * Exit value of the finished process.
   */
  private final int exitValue;

  /**
   * Process output or null if it wasn't read.
   */
  private final ProcessOutput output;

  public ProcessResult(int exitCode, ProcessOutput output) {
    this.exitValue = exitCode;
    this.output = output;
  }

  /**
   * @return the exit value of the finished process.
   */
  public int getExitValue() {
    return exitValue;
  }

  /**
   * @return the exit value of the finished process.
   * @deprecated use {@link #getExitValue()}
   */
  public int exitValue() {
    return getExitValue();
  }

  /**
   * @return true if the process output was read.
   */
  public boolean hasOutput() {
    return output != null;
  }

  /**
   * @return output of the finished process.
   * You have to invoke {@link ProcessExecutor#readOutput(boolean)} to set the process output to be read.
   *
   * @throws IllegalStateException if the output was not read.
   */
  public ProcessOutput getOutput() {
    if (output == null)
      throw new IllegalStateException("Process output was not read. To enable output reading please call ProcessExecutor.readOutput(true) before starting the process.");
    return output;
  }

  /**
   * @return binary output of the finished process.
   * You have to invoke {@link ProcessExecutor#readOutput(boolean)} to set the process output to be read.
   *
   * @throws IllegalStateException if the output was not read.
   */
  public byte[] output() {
    return getOutput().getBytes();
  }

  /**
   * @return output of the finished process converted to a String using platform's default encoding.
   * You have to invoke {@link ProcessExecutor#readOutput(boolean)} to set the process output to be read.
   *
   * @throws IllegalStateException if the output was not read.
   */
  public String outputString() {
    return getOutput().getString();
  }

  /**
   * @return output of the finished process converted to UTF-8 String.
   * You have to invoke {@link ProcessExecutor#readOutput(boolean)} to set the process output to be read.
   *
   * @throws IllegalStateException if the output was not read.
   */
  public String outputUTF8() {
    return getOutput().getUTF8();
  }

  /**
   * @return output of the finished process converted to a String.
   * You have to invoke {@link ProcessExecutor#readOutput(boolean)} to set the process output to be read.
   *
   * @param charset The name of a supported char set.
   * @throws IllegalStateException if the output was not read or the char set was not supported.
   */
  public String outputString(String charset) {
    return getOutput().getString(charset);
  }

}