001 /*
002 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 /*
026 * $Id: TransformException.java,v 1.3 2005/05/10 16:03:48 mullan Exp $
027 */
028 package javax.xml.crypto.dsig;
029
030 import java.io.PrintStream;
031 import java.io.PrintWriter;
032
033 /**
034 * Indicates an exceptional condition that occured while executing a
035 * transform algorithm.
036 *
037 * <p>A <code>TransformException</code> can contain a cause: another
038 * throwable that caused this <code>TransformException</code> to get thrown.
039 *
040 * @see Transform#transform
041 * @author Sean Mullan
042 * @author JSR 105 Expert Group
043 * @since 1.6
044 */
045 public class TransformException extends Exception {
046
047 private static final long serialVersionUID = 5082634801360427800L;
048
049 /**
050 * The throwable that caused this exception to get thrown, or null if this
051 * exception was not caused by another throwable or if the causative
052 * throwable is unknown.
053 *
054 * @serial
055 */
056 private Throwable cause;
057
058 /**
059 * Constructs a new <code>TransformException</code> with
060 * <code>null</code> as its detail message.
061 */
062 public TransformException() {
063 super ();
064 }
065
066 /**
067 * Constructs a new <code>TransformException</code> with the specified
068 * detail message.
069 *
070 * @param message the detail message
071 */
072 public TransformException(String message) {
073 super (message);
074 }
075
076 /**
077 * Constructs a new <code>TransformException</code> with the
078 * specified detail message and cause.
079 * <p>Note that the detail message associated with
080 * <code>cause</code> is <i>not</i> automatically incorporated in
081 * this exception's detail message.
082 *
083 * @param message the detail message
084 * @param cause the cause (A <tt>null</tt> value is permitted, and
085 * indicates that the cause is nonexistent or unknown.)
086 */
087 public TransformException(String message, Throwable cause) {
088 super (message);
089 this .cause = cause;
090 }
091
092 /**
093 * Constructs a new <code>TransformException</code> with the specified
094 * cause and a detail message of
095 * <code>(cause==null ? null : cause.toString())</code>
096 * (which typically contains the class and detail message of
097 * <code>cause</code>).
098 *
099 * @param cause the cause (A <tt>null</tt> value is permitted, and
100 * indicates that the cause is nonexistent or unknown.)
101 */
102 public TransformException(Throwable cause) {
103 super (cause == null ? null : cause.toString());
104 this .cause = cause;
105 }
106
107 /**
108 * Returns the cause of this <code>TransformException</code> or
109 * <code>null</code> if the cause is nonexistent or unknown. (The
110 * cause is the throwable that caused this
111 * <code>TransformException</code> to get thrown.)
112 *
113 * @return the cause of this <code>TransformException</code> or
114 * <code>null</code> if the cause is nonexistent or unknown.
115 */
116 public Throwable getCause() {
117 return cause;
118 }
119
120 /**
121 * Prints this <code>TransformException</code>, its backtrace and
122 * the cause's backtrace to the standard error stream.
123 */
124 public void printStackTrace() {
125 super .printStackTrace();
126 if (cause != null) {
127 cause.printStackTrace();
128 }
129 }
130
131 /**
132 * Prints this <code>TransformException</code>, its backtrace and
133 * the cause's backtrace to the specified print stream.
134 *
135 * @param s <code>PrintStream</code> to use for output
136 */
137 public void printStackTrace(PrintStream s) {
138 super .printStackTrace(s);
139 if (cause != null) {
140 cause.printStackTrace(s);
141 }
142 }
143
144 /**
145 * Prints this <code>TransformException</code>, its backtrace and
146 * the cause's backtrace to the specified print writer.
147 *
148 * @param s <code>PrintWriter</code> to use for output
149 */
150 public void printStackTrace(PrintWriter s) {
151 super.printStackTrace(s);
152 if (cause != null) {
153 cause.printStackTrace(s);
154 }
155 }
156 }
|