View Javadoc
1   /*
2    * Copyright (C) 2016, Matthias Sohn <matthias.sohn@sap.com>
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.errors;
44  
45  /**
46   * Thrown when an external command failed
47   *
48   * @since 4.5
49   */
50  public class CommandFailedException extends Exception {
51  
52  	private static final long serialVersionUID = 1L;
53  
54  	private int returnCode;
55  
56  	/**
57  	 * Constructor for CommandFailedException
58  	 *
59  	 * @param returnCode
60  	 *            return code returned by the command
61  	 * @param message
62  	 *            error message
63  	 */
64  	public CommandFailedException(int returnCode, String message) {
65  		super(message);
66  		this.returnCode = returnCode;
67  	}
68  
69  	/**
70  	 * Constructor for CommandFailedException
71  	 *
72  	 * @param returnCode
73  	 *            return code returned by the command
74  	 * @param message
75  	 *            error message
76  	 * @param cause
77  	 *            exception causing this exception
78  	 */
79  	public CommandFailedException(int returnCode, String message,
80  			Throwable cause) {
81  		super(message, cause);
82  		this.returnCode = returnCode;
83  	}
84  
85  	/**
86  	 * Get return code returned by the command
87  	 *
88  	 * @return return code returned by the command
89  	 */
90  	public int getReturnCode() {
91  		return returnCode;
92  	}
93  }