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

Go to download

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.

There is a newer version: 1.12

/*
 * Copyright (C) 2013 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;

import java.util.Collection;

/**
 * Process finished with a forbidden exit value.
 *
 * @author Rein Raudjärv
 *
 * @see ProcessExecutor#exitValues(Integer...)
 */
public class InvalidExitValueException extends RuntimeException {

  private static final long serialVersionUID = 1L;

  /**
   * Actual exit value and process output.
   */
  private final ProcessResult result;

  /**
   * @param exitValue The exit value
   */
  public InvalidExitValueException(ProcessResult result, Collection allowedExitValues) {
    super("Unexpected exit value: " + result.exitValue() + ", allowed exit values: " + allowedExitValues);
    this.result = result;
  }

  /**
   * @return actual process result.
   */
  public ProcessResult result() {
    return result;
  }

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

}