14c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson/*
24c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one
34c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * or more contributor license agreements. See the NOTICE file
44c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * distributed with this work for additional information
54c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * regarding copyright ownership. The ASF licenses this file
64c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * to you under the Apache License, Version 2.0 (the  "License");
74c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * you may not use this file except in compliance with the License.
84c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * You may obtain a copy of the License at
94c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson *
104c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson *     http://www.apache.org/licenses/LICENSE-2.0
114c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson *
124c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * Unless required by applicable law or agreed to in writing, software
134c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS,
144c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
154c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * See the License for the specific language governing permissions and
164c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * limitations under the License.
174c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson */
184c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson/*
194c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * $Id: DTMConfigurationException.java 468653 2006-10-28 07:07:05Z minchau $
204c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson */
214c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilsonpackage org.apache.xml.dtm;
224c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
234c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilsonimport javax.xml.transform.SourceLocator;
244c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
254c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson/**
264c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * Indicates a serious configuration error.
274c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson */
284c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilsonpublic class DTMConfigurationException extends DTMException {
294c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    static final long serialVersionUID = -4607874078818418046L;
304c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
314c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    /**
324c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * Create a new <code>DTMConfigurationException</code> with no
334c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * detail mesage.
344c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     */
354c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    public DTMConfigurationException() {
364c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson        super("Configuration Error");
374c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    }
384c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
394c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    /**
404c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * Create a new <code>DTMConfigurationException</code> with
414c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * the <code>String </code> specified as an error message.
424c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *
434c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param msg The error message for the exception.
444c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     */
454c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    public DTMConfigurationException(String msg) {
464c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson        super(msg);
474c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    }
484c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
494c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    /**
504c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * Create a new <code>DTMConfigurationException</code> with a
514c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * given <code>Exception</code> base cause of the error.
524c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *
534c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param e The exception to be encapsulated in a
544c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * DTMConfigurationException.
554c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     */
564c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    public DTMConfigurationException(Throwable e) {
574c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson        super(e);
584c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    }
594c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
604c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    /**
614c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * Create a new <code>DTMConfigurationException</code> with the
624c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * given <code>Exception</code> base cause and detail message.
634c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *
644c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param msg The detail message.
654c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param e The exception to be wrapped in a DTMConfigurationException
664c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     */
674c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    public DTMConfigurationException(String msg, Throwable e) {
684c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson        super(msg, e);
694c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    }
704c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
714c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    /**
724c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * Create a new DTMConfigurationException from a message and a Locator.
734c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *
744c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * <p>This constructor is especially useful when an application is
754c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * creating its own exception from within a DocumentHandler
764c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * callback.</p>
774c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *
784c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param message The error or warning message.
794c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param locator The locator object for the error or warning.
804c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     */
814c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    public DTMConfigurationException(String message,
824c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson                                             SourceLocator locator) {
834c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson        super(message, locator);
844c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    }
854c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
864c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    /**
874c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * Wrap an existing exception in a DTMConfigurationException.
884c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *
894c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param message The error or warning message, or null to
904c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     *                use the message from the embedded exception.
914c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param locator The locator object for the error or warning.
924c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     * @param e Any exception.
934c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson     */
944c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    public DTMConfigurationException(String message,
954c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson                                             SourceLocator locator,
964c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson                                             Throwable e) {
974c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson        super(message, locator, e);
984c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson    }
994c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson}
100