1 /*
   2  * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.xpath;
  27 
  28 import java.io.PrintWriter;
  29 
  30 /**
  31  * <code>XPathException</code> represents a generic XPath exception.</p>
  32  *
  33  * @author  <a href="Norman.Walsh@Sun.com">Norman Walsh</a>
  34  * @author <a href="mailto:Jeff.Suttor@Sun.COM">Jeff Suttor</a>
  35  * @since 1.5
  36  */
  37 public class XPathException extends Exception {
  38 
  39     private final Throwable cause;
  40 
  41     /**
  42      * <p>Stream Unique Identifier.</p>
  43      */
  44     private static final long serialVersionUID = -1837080260374986980L;
  45 
  46     /**
  47      * <p>Constructs a new <code>XPathException</code>
  48      * with the specified detail <code>message</code>.</p>
  49      *
  50      * <p>The <code>cause</code> is not initialized.</p>
  51      *
  52      * <p>If <code>message</code> is <code>null</code>,
  53      * then a <code>NullPointerException</code> is thrown.</p>
  54      *
  55      * @param message The detail message.
  56      *
  57      * @throws NullPointerException When <code>message</code> is
  58      *   <code>null</code>.
  59      */
  60     public XPathException(String message) {
  61         super(message);
  62         if ( message == null ) {
  63             throw new NullPointerException ( "message can't be null");
  64         }
  65         this.cause = null;
  66     }
  67 
  68     /**
  69      * <p>Constructs a new <code>XPathException</code>
  70      * with the specified <code>cause</code>.</p>
  71      *
  72      * <p>If <code>cause</code> is <code>null</code>,
  73      * then a <code>NullPointerException</code> is thrown.</p>
  74      *
  75      * @param cause The cause.
  76      *
  77      * @throws NullPointerException if <code>cause</code> is <code>null</code>.
  78      */
  79     public XPathException(Throwable cause) {
  80         super();
  81         this.cause = cause;
  82         if ( cause == null ) {
  83             throw new NullPointerException ( "cause can't be null");
  84         }
  85     }
  86 
  87     /**
  88      * <p>Get the cause of this XPathException.</p>
  89      *
  90      * @return Cause of this XPathException.
  91      */
  92     public Throwable getCause() {
  93         return cause;
  94     }
  95 
  96     /**
  97      * <p>Print stack trace to specified <code>PrintStream</code>.</p>
  98      *
  99      * @param s Print stack trace to this <code>PrintStream</code>.
 100      */
 101     public void printStackTrace(java.io.PrintStream s) {
 102         if (getCause() != null) {
 103             getCause().printStackTrace(s);
 104           s.println("--------------- linked to ------------------");
 105         }
 106 
 107         super.printStackTrace(s);
 108     }
 109 
 110     /**
 111      * <p>Print stack trace to <code>System.err</code>.</p>
 112      */
 113     public void printStackTrace() {
 114         printStackTrace(System.err);
 115     }
 116 
 117     /**
 118      * <p>Print stack trace to specified <code>PrintWriter</code>.</p>
 119      *
 120      * @param s Print stack trace to this <code>PrintWriter</code>.
 121      */
 122     public void printStackTrace(PrintWriter s) {
 123 
 124         if (getCause() != null) {
 125             getCause().printStackTrace(s);
 126           s.println("--------------- linked to ------------------");
 127         }
 128 
 129         super.printStackTrace(s);
 130     }
 131 }