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