1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.commons.exec;
21
22 import java.io.IOException;
23
24 /**
25 * An exception indicating that the executing a subprocesses failed.
26 */
27 public class ExecuteException extends IOException {
28
29 /**
30 * Comment for {@code serialVersionUID}.
31 */
32 private static final long serialVersionUID = 3256443620654331699L;
33
34 /**
35 * The exit value returned by the failed process.
36 */
37 private final int exitValue;
38
39 /**
40 * Constructs a new exception with the specified detail message.
41 *
42 * @param message The detail message.
43 * @param exitValue The exit value.
44 */
45 public ExecuteException(final String message, final int exitValue) {
46 super(message + " (Exit value: " + exitValue + ")");
47 this.exitValue = exitValue;
48 }
49
50 /**
51 * Constructs a new exception with the specified detail message and cause.
52 *
53 * @param message The detail message.
54 * @param exitValue The exit value.
55 * @param cause The underlying cause.
56 */
57 public ExecuteException(final String message, final int exitValue, final Throwable cause) {
58 super(message + " (Exit value: " + exitValue + ")", cause);
59 this.exitValue = exitValue;
60 }
61
62 /**
63 * Gets the exit value returned by the failed process.
64 *
65 * @return The exit value.
66 */
67 public int getExitValue() {
68 return exitValue;
69 }
70 }