View Javadoc
1 /* ====================================================================
2 * License:
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. The end-user documentation included with the redistribution,
17 * if any, must include the following acknowledgment:
18 * "This product includes software developed by
19 * Robert Half International (http://www.rhi.com/)."
20 * Alternately, this acknowledgment may appear in the software itself,
21 * if and wherever such third-party acknowledgments normally appear.
22 *
23 * 4. The names "Parc", "RHI", and "Robert Half International" must
24 * not be used to endorse or promote products derived from this
25 * software without prior written permission. For written
26 * permission, please contact pete.mckinstry@rhi.com.
27 *
28 * 5. Products derived from this software may not be called "PARC",
29 * nor may "PARC" appear in their name, without prior written
30 * permission of Robert Half International.
31 *
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 * ====================================================================
45 *
46 */
47 package com.rhi.architecture.batch;
48
49 import org.apache.commons.lang.exception.NestableException;
50
51 /***
52 * ApplicationException Class
53 *
54 * @author Pete McKinstry
55 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
56 *
57 * @since 1.0
58 */
59 public class ApplicationException extends NestableException {
60
61 /***
62 * the exit code - allows tracking of fatal vs. non-fatal application
63 * exceptions.
64 */
65 private int exitCode;
66
67 /***
68 * Default Constructor
69 */
70 public ApplicationException() {
71 super();
72 exitCode = Application.FATAL_EXCEPTION; // default = fatal error
73 }
74
75 /***
76 * Constructor
77 *
78 * @param msg - the exception msg.
79 */
80 public ApplicationException(String msg) {
81 super(msg);
82 exitCode = Application.FATAL_EXCEPTION;
83 }
84
85 /***
86 * Constructor
87 *
88 * @param msg - the exception msg.
89 * @param code - the exit code
90 */
91 public ApplicationException(String msg, int code) {
92 super(msg);
93 this.exitCode = code;
94 }
95
96 /***
97 * Constructor
98 *
99 * @param cause -the root exception causing the app exception.
100 */
101 public ApplicationException(Throwable cause) {
102 super(cause);
103 this.exitCode = Application.FATAL_EXCEPTION;
104 }
105
106 /***
107 * Constructor
108 *
109 * @param cause -the root exception causing the app exception.
110 * @param code - the exit code
111 */
112 public ApplicationException(Throwable cause, int code) {
113 super(cause);
114 this.exitCode = code;
115 }
116
117 /***
118 * Constructor
119 *
120 * @param msg the reason for the exception
121 * @param cause - the root cause exception.
122 */
123 public ApplicationException(String msg, Throwable cause) {
124 super(msg, cause);
125 this.exitCode = Application.FATAL_EXCEPTION;
126 }
127
128 /***
129 * Constructor
130 *
131 * @param msg the reason for the exception
132 * @param code - the exit code.
133 * @param cause - the root exception
134 */
135 public ApplicationException(String msg, Throwable cause, int code) {
136 super(msg, cause);
137 this.exitCode = code;
138 }
139
140 /***
141 * get returnCode
142 * @return exit code that should be returned from the application
143 * due to this exception.
144 */
145 public int getExitCode() {
146 return exitCode;
147 }
148 /***
149 * set returnCode
150 * @param exitCode
151 */
152 public void setExitCode(int exitCode) {
153 this.exitCode = exitCode;
154 }
155
156 }
This page was automatically generated by Maven