1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /*
   6  * Copyright 1999-2004 The Apache Software Foundation.
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20 /*
  21  * $Id: DTMConfigurationException.java,v 1.2.4.1 2005/09/15 08:14:52 suresh_emailid Exp $
  22  */
  23 package com.sun.org.apache.xml.internal.dtm;
  24 
  25 import javax.xml.transform.SourceLocator;
  26 
  27 /**
  28  * Indicates a serious configuration error.
  29  */
  30 public class DTMConfigurationException extends DTMException {
  31     static final long serialVersionUID = -4607874078818418046L;
  32 
  33     /**
  34      * Create a new <code>DTMConfigurationException</code> with no
  35      * detail mesage.
  36      */
  37     public DTMConfigurationException() {
  38         super("Configuration Error");
  39     }
  40 
  41     /**
  42      * Create a new <code>DTMConfigurationException</code> with
  43      * the <code>String </code> specified as an error message.
  44      *
  45      * @param msg The error message for the exception.
  46      */
  47     public DTMConfigurationException(String msg) {
  48         super(msg);
  49     }
  50 
  51     /**
  52      * Create a new <code>DTMConfigurationException</code> with a
  53      * given <code>Exception</code> base cause of the error.
  54      *
  55      * @param e The exception to be encapsulated in a
  56      * DTMConfigurationException.
  57      */
  58     public DTMConfigurationException(Throwable e) {
  59         super(e);
  60     }
  61 
  62     /**
  63      * Create a new <code>DTMConfigurationException</code> with the
  64      * given <code>Exception</code> base cause and detail message.
  65      *
  66      * @param msg The detail message.
  67      * @param e The exception to be wrapped in a DTMConfigurationException
  68      */
  69     public DTMConfigurationException(String msg, Throwable e) {
  70         super(msg, e);
  71     }
  72 
  73     /**
  74      * Create a new DTMConfigurationException from a message and a Locator.
  75      *
  76      * <p>This constructor is especially useful when an application is
  77      * creating its own exception from within a DocumentHandler
  78      * callback.</p>
  79      *
  80      * @param message The error or warning message.
  81      * @param locator The locator object for the error or warning.
  82      */
  83     public DTMConfigurationException(String message,
  84                                              SourceLocator locator) {
  85         super(message, locator);
  86     }
  87 
  88     /**
  89      * Wrap an existing exception in a DTMConfigurationException.
  90      *
  91      * @param message The error or warning message, or null to
  92      *                use the message from the embedded exception.
  93      * @param locator The locator object for the error or warning.
  94      * @param e Any exception.
  95      */
  96     public DTMConfigurationException(String message,
  97                                              SourceLocator locator,
  98                                              Throwable e) {
  99         super(message, locator, e);
 100     }
 101 }