/*
 * Copyright (c) 2000, 2017 Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2021 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.xml.messaging;

import jakarta.xml.soap.*;

/**
 * An exception that signals that a JAXM exception has occurred. A <code>JAXMException</code> object may contain a
 * <code>String</code> that gives the reason for the exception, an embedded <code>Throwable</code> object, or both. This
 * class provides methods for retrieving reason messages and for retrieving the embedded <code>Throwable</code> object.
 *
 * <P>
 * Typical reasons for throwing a <code>JAXMException</code> object are problems such as not being able to send a
 * message and not being able to get a connection with the provider. Reasons for embedding a <code>Throwable</code>
 * object include problems such as an input/output errors or a parsing problem, such as an error parsing a header.
 *
 * @deprecated since 6.2, will be removed without replacement
 */
@Deprecated
public class JAXMException extends SOAPException {

    /**
     * 
     */
    private static final long serialVersionUID = 2558663345734421756L;

    /**
     * Constructs a <code>JAXMException</code> object with no reason or embedded <code>Throwable</code> object.
     */
    public JAXMException() {
    }

    /**
     * Constructs a <code>JAXMException</code> object with the given <code>String</code> as the reason for the exception
     * being thrown.
     *
     * @param reason a <code>String</code> giving a description of what caused this exception
     */
    public JAXMException(String reason) {
        super(reason);
    }

    /**
     * Constructs a <code>JAXMException</code> object with the given <code>String</code> as the reason for the exception
     * being thrown and the given <code>Throwable</code> object as an embedded exception.
     *
     * @param reason a <code>String</code> giving a description of what caused this exception
     * @param cause a <code>Throwable</code> object that is to be embedded in this <code>JAXMException</code> object
     */
    public JAXMException(String reason, Throwable cause) {
        super(reason, cause);
    }

    /**
     * Constructs a <code>JAXMException</code> object initialized with the given <code>Throwable</code> object.
     *
     * @param cause a <code>Throwable</code> object that is to be embedded in this <code>JAXMException</code> object
     */
    public JAXMException(Throwable cause) {
        super(cause);
    }
}
