1 /*
   2  * Copyright (c) 2009, 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.stream;
  27 
  28 /**
  29  * The base exception for unexpected processing errors.  This Exception
  30  * class is used to report well-formedness errors as well as unexpected
  31  * processing conditions.
  32  * @version 1.0
  33  * @author Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
  34  * @since 1.6
  35  */
  36 
  37 public class XMLStreamException extends Exception {
  38 
  39   protected Throwable nested;
  40   protected Location location;
  41 
  42   /**
  43    * Default constructor
  44    */
  45   public XMLStreamException(){
  46     super();
  47   }
  48 
  49   /**
  50    * Construct an exception with the assocated message.
  51    *
  52    * @param msg the message to report
  53    */
  54   public XMLStreamException(String msg) {
  55     super(msg);
  56   }
  57 
  58   /**
  59    * Construct an exception with the assocated exception
  60    *
  61    * @param th a nested exception
  62    */
  63   public XMLStreamException(Throwable th) {
  64       super(th);
  65     nested = th;
  66   }
  67 
  68   /**
  69    * Construct an exception with the assocated message and exception
  70    *
  71    * @param th a nested exception
  72    * @param msg the message to report
  73    */
  74   public XMLStreamException(String msg, Throwable th) {
  75     super(msg, th);
  76     nested = th;
  77   }
  78 
  79   /**
  80    * Construct an exception with the assocated message, exception and location.
  81    *
  82    * @param th a nested exception
  83    * @param msg the message to report
  84    * @param location the location of the error
  85    */
  86   public XMLStreamException(String msg, Location location, Throwable th) {
  87     super("ParseError at [row,col]:["+location.getLineNumber()+","+
  88           location.getColumnNumber()+"]\n"+
  89           "Message: "+msg);
  90     nested = th;
  91     this.location = location;
  92   }
  93 
  94   /**
  95    * Construct an exception with the assocated message, exception and location.
  96    *
  97    * @param msg the message to report
  98    * @param location the location of the error
  99    */
 100   public XMLStreamException(String msg,
 101                             Location location) {
 102     super("ParseError at [row,col]:["+location.getLineNumber()+","+
 103           location.getColumnNumber()+"]\n"+
 104           "Message: "+msg);
 105     this.location = location;
 106   }
 107 
 108 
 109   /**
 110    * Gets the nested exception.
 111    *
 112    * @return Nested exception
 113    */
 114   public Throwable getNestedException() {
 115     return nested;
 116   }
 117 
 118   /**
 119    * Gets the location of the exception
 120    *
 121    * @return the location of the exception, may be null if none is available
 122    */
 123   public Location getLocation() {
 124     return location;
 125   }
 126 
 127 }