1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.resource.cci;
38
39 /**
40 * A <code>ResourceWarning</code> provides information on warnings related to
41 * execution of an interaction with an EIS. Warnings are silently
42 * chained to the object whose method caused it to be reported.
43 *
44 * @see Interaction#getWarnings
45 */
46 public class ResourceWarning extends javax.resource.ResourceException {
47
48 /**
49 * Constructs a new instance with null as its detail message.
50 */
51 public ResourceWarning() { super(); }
52
53 /**
54 * Constructs a new instance with the specified detail message.
55 *
56 * @param message the detail message.
57 */
58 public ResourceWarning(String message) {
59 super(message);
60 }
61
62 /**
63 * Constructs a new throwable with the specified cause.
64 *
65 * @param cause a chained exception of type
66 * <code>Throwable</code>.
67 */
68 public ResourceWarning(Throwable cause) {
69 super(cause);
70 }
71
72 /**
73 * Constructs a new throwable with the specified detail message and cause.
74 *
75 * @param message the detail message.
76 *
77 * @param cause a chained exception of type
78 * <code>Throwable</code>.
79 */
80 public ResourceWarning(String message, Throwable cause) {
81 super(message, cause);
82 }
83
84 /**
85 * Constructs a new throwable with the specified detail message and
86 * an error code.
87 *
88 * @param message a description of the exception.
89 * @param errorCode a string specifying the vendor specific error code.
90 */
91 public ResourceWarning(String message, String errorCode) {
92 super(message, errorCode);
93 }
94
95 /**
96 * Retrieves the warning chained to this <code>ResourceWarning</code>
97 * object.
98 *
99 * @return next <code>ResourceWarning</code> in the chain; null if none.
100 *
101 * @deprecated J2SE release 1.4 supports a chained exception facility
102 * that allows any throwable to know about another throwable, if any,
103 * that caused it to get thrown. Refer to <code>getCause</code> and
104 * <code>initCause</code> methods of the
105 * <code>java.lang.Throwable</code> class.
106 */
107 public ResourceWarning getLinkedWarning() {
108 try {
109 return ((ResourceWarning)getLinkedException());
110 }
111 catch (ClassCastException ex) {
112 return null;
113 }
114 }
115
116 /**
117 * Adds an <code>ResourceWarning</code> object to the end of the chain.
118 *
119 * @param warning <code>ResourceWarning</code> to be added to the chain.
120 *
121 * @deprecated J2SE release 1.4 supports a chained exception facility
122 * that allows any throwable to know about another throwable, if any,
123 * that caused it to get thrown. Refer to <code>getCause</code> and
124 * <code>initCause</code> methods of the
125 * <code>java.lang.Throwable</code> class.
126 */
127 public void setLinkedWarning(ResourceWarning warning) {
128 setLinkedException(warning);
129 }
130 }
Save This Page