1 /*
2 * Copyright (C) 2009, Google Inc.
3 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.pgm;
46
47 /**
48 * Indicates a {@link TextBuiltin} implementation has failed during execution.
49 * <p>
50 * Typically the stack trace for a Die exception is not shown to the user as it
51 * may indicate a simple error condition that the end-user can fix on their own,
52 * without needing a screen of Java stack frames.
53 */
54 public class Die extends RuntimeException {
55 private static final long serialVersionUID = 1L;
56
57 private boolean aborted;
58
59 /**
60 * Construct a new message explaining what has gone wrong.
61 *
62 * @param why
63 * the message to show to the end-user.
64 */
65 public Die(final String why) {
66 super(why);
67 }
68
69 /**
70 * Construct a new message explaining what has gone wrong.
71 *
72 * @param why
73 * the message to show to the end-user.
74 * @param cause
75 * why the command has failed.
76 */
77 public Die(final String why, final Throwable cause) {
78 super(why, cause);
79 }
80
81 /**
82 * Construct a new exception reflecting the fact that the
83 * command execution has been aborted before running.
84 *
85 * @param aborted boolean indicating the fact the execution has been aborted
86 * @since 3.4
87 */
88 public Die(boolean aborted) {
89 this(aborted, null);
90 }
91
92 /**
93 * Construct a new exception reflecting the fact that the command execution
94 * has been aborted before running.
95 *
96 * @param aborted
97 * boolean indicating the fact the execution has been aborted
98 * @param cause
99 * can be null
100 * @since 4.2
101 */
102 public Die(boolean aborted, final Throwable cause) {
103 super(cause != null ? cause.getMessage() : null, cause);
104 this.aborted = aborted;
105 }
106
107 /**
108 * Check if this exception should cause the execution to be aborted.
109 *
110 * @return boolean indicating that the execution should be aborted
111 * @since 3.4
112 */
113 public boolean isAborted() {
114 return aborted;
115 }
116 }