1 /*
2 * Copyright (C) 2014 Obeo.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.util;
44
45 /**
46 * Describes the result of running an external process.
47 *
48 * @since 3.7
49 */
50 public class ProcessResult {
51 /**
52 * Status of a process' execution.
53 */
54 public static enum Status {
55 /**
56 * The script was found and launched properly. It may still have exited
57 * with a non-zero {@link #exitCode}.
58 */
59 OK,
60
61 /** The script was not found on disk and thus could not be launched. */
62 NOT_PRESENT,
63
64 /**
65 * The script was found but could not be launched since it was not
66 * supported by the current {@link FS}.
67 */
68 NOT_SUPPORTED;
69 }
70
71 /** The exit code of the process. */
72 private final int exitCode;
73
74 /** Status of the process' execution. */
75 private final Status status;
76
77 /**
78 * Instantiates a process result with the given status and an exit code of
79 * <code>-1</code>.
80 *
81 * @param status
82 * Status describing the execution of the external process.
83 */
84 public ProcessResult(Status status) {
85 this(-1, status);
86 }
87
88 /**
89 * <p>Constructor for ProcessResult.</p>
90 *
91 * @param exitCode
92 * Exit code of the process.
93 * @param status
94 * Status describing the execution of the external process.
95 */
96 public ProcessResult(int exitCode, Status status) {
97 this.exitCode = exitCode;
98 this.status = status;
99 }
100
101 /**
102 * Get exit code of the process.
103 *
104 * @return The exit code of the process.
105 */
106 public int getExitCode() {
107 return exitCode;
108 }
109
110 /**
111 * Get the status of the process' execution.
112 *
113 * @return The status of the process' execution.
114 */
115 public Status getStatus() {
116 return status;
117 }
118
119 /**
120 * Whether the execution occurred and resulted in an error
121 *
122 * @return <code>true</code> if the execution occurred and resulted in a
123 * return code different from 0, <code>false</code> otherwise.
124 * @since 4.0
125 */
126 public boolean isExecutedWithError() {
127 return getStatus() == ProcessResult.Status.OK && getExitCode() != 0;
128 }
129 }