javax.xml.bind.JAXBException Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2003,2004  The Apache Software Foundation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.

 */
package javax.xml.bind;

import java.io.PrintStream;
import java.io.PrintWriter;

/** This is the main exception class of JAXB. All other
 * exception classes (except the {@link javax.xml.bind.TypeConstraintException},
 * which is a {@link java.lang.RuntimeException} are derived from the
 * JAXBException.
 *
 * @author JSR-31
 * @since JAXB1.0
 */
public class JAXBException extends Exception {
    private String errorCode;
    private Throwable linkedException;
    
    /** Creates a new JAXBException with the specified
     * detail message.
     * @param pMessage The detail message.
     */
    public JAXBException(String pMessage) {
        super(pMessage);
    }

    private static String formatMessage(String pErrorCode, String pMessage, Throwable pThr) {
    	String msg = null;
        if (pMessage == null) {
            if (pThr != null) {
            	msg = pThr.getMessage();
                if (msg == null) {
                	msg = pThr.getClass().getName();
                }
            }
        } else {
        	msg = pMessage;
        }
        if (pErrorCode == null) {
        	return msg;
        } else {
            if (msg == null) {
            	return pErrorCode;
            } else {
            	return pErrorCode + ": " + msg;
            }
        }
        
    }

    /** Creates a new JAXBException with the specified
     * detail message and vendor specific error code.
     * @param pMessage The detail message.
     * @param pErrorCode The error code.
     */
    public JAXBException(String pMessage, String pErrorCode) {
        this(pMessage, pErrorCode, null);
    }
    
    /** Creates a new JAXBException with the specified
     * linked exception.
     * @param pLinkedException The linked exception.
     */
    public JAXBException(Throwable pLinkedException) {
        this(null, null, pLinkedException);
    }
    
    /** Creates a new JAXBException with the specified
     * detail message and linked exception.
     * @param pMessage The detail message.
     * @param pLinkedException The linked exception.
     */
    public JAXBException(String pMessage, Throwable pLinkedException) {
        this(pMessage, null, pLinkedException);
    }
    
    /** Creates a new JAXBException with the specified
     * detail message, error code, and linked exception.
     * @param pMessage The detail message.
     * @param pErrorCode The vendor specific error code.
     * @param pLinkedException The linked exception.
     */
    public JAXBException(String pMessage, String pErrorCode,
						 Throwable pLinkedException) {
        super(formatMessage(pErrorCode, pMessage, pLinkedException));
        errorCode = pErrorCode;
        linkedException = pLinkedException;
    }
    
    /** Returns the vendor specific error code, if any, or null.
     */
    public String getErrorCode() {
        return errorCode;
    }
    
    /** Returns the linked exception, if any, or null.
     */
    public Throwable getLinkedException() {
        return linkedException;
    }
    
    /** Sets the linked exception.
     * @param pLinkedException The linked exception or null.
     */
    public void setLinkedException(Throwable pLinkedException) {
        linkedException = pLinkedException;
    }
    
    /** Converts the linked exception into a String. Overridden,
     * because the returned string should contain the vendor specific
     * error code, if any.
     */
    public String toString() {
        if (errorCode == null  ||  errorCode.length() == 0) {
            return super.toString();
        } else {
            return errorCode + ": " + super.toString();
        }
    }

    public void printStackTrace() {
        printStackTrace(System.err);
    }

    public void printStackTrace(PrintStream pStream) {
        super.printStackTrace(pStream);
        Throwable t = getLinkedException();
        if (t != null) {
            pStream.println("Caused by:");
            t.printStackTrace(pStream);
        }
    }

    public void printStackTrace(PrintWriter pWriter) {
        super.printStackTrace(pWriter);
        Throwable t = getLinkedException();
        if (t != null) {
            pWriter.println("Caused by:");
            t.printStackTrace(pWriter);
        }
    }
}