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 examples;
48
49 import com.rhi.architecture.parc.AbstractError;
50 import com.rhi.architecture.parc.ErrorType;
51
52 /***
53 * Errors are added to the record at any time during processing. This class
54 * (MyError) shows a simple example of how an error class might look. Note that
55 * it requires a generateLogMessage(). This is the message that typically gets
56 * written to the logfile. It allows you to do some fancy formatting of the
57 * message if you desire. Other than that method, your Error object can do
58 * whatever is necessary to capture the error & render it correctly.
59 * It is possible to check the Errors in the OutputAdapter and write them to an
60 * error table, an error queue (JMS or whatever), or just log them in a separate
61 * logfile. This behaviour is handled in the OutputAdapter, but the Error object
62 * is a key player in the exchange.
63 *
64 * @author <a href="mailto:pmckinstry@users.sourceforge.net">Pete McKinstry</a>
65 */
66 public class MyError extends AbstractError {
67
68 private String msg;
69
70 /***
71 * Constructor for MyError.
72 * @param msg
73 */
74 public MyError(String msg) {
75 super();
76 this.msg = msg;
77 }
78
79 /***
80 * Constructor for MyError.
81 * @param msg
82 * @param type
83 */
84 public MyError(String msg, ErrorType type) {
85 super(type);
86 this.msg = msg;
87 }
88
89 /***
90 * @see com.rhi.architecture.parc.Error#generateLogMessage()
91 * @return String
92 */
93 public String generateLogMessage() {
94 return msg;
95 }
96
97 }
This page was automatically generated by Maven