001/**
002The contents of this file are subject to the Mozilla Public License Version 1.1 
003(the "License"); you may not use this file except in compliance with the License. 
004You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005Software distributed under the License is distributed on an "AS IS" basis, 
006WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007specific language governing rights and limitations under the License. 
008
009The Original Code is "LLPException.java".  Description: 
010"Represents a problem encountered while using a Lower Layer Protocol" 
011
012The Initial Developer of the Original Code is University Health Network. Copyright (C) 
0132001.  All Rights Reserved. 
014
015Contributor(s): ______________________________________. 
016
017Alternatively, the contents of this file may be used under the terms of the 
018GNU General Public License (the  �GPL�), in which case the provisions of the GPL are 
019applicable instead of those above.  If you wish to allow use of your version of this 
020file only under the terms of the GPL and not to allow others to use your version 
021of this file under the MPL, indicate your decision by deleting  the provisions above 
022and replace  them with the notice and other provisions required by the GPL License.  
023If you do not delete the provisions above, a recipient may use your version of 
024this file under either the MPL or the GPL. 
025
026*/
027
028package ca.uhn.hl7v2.llp;
029
030/**
031 * Represents a problem encountered while using a Lower Layer Protocol.  This exception  
032 * serves to wrap the wide variety of other exceptions that might be encountered with 
033 * various protocols.  
034 * @author  Bryan Tripp
035 */
036@SuppressWarnings("serial")
037public class LLPException extends Exception {
038
039    /**
040     * Constructs an <code>LLPException</code> with the specified detail message.
041     * @param msg the detail message.
042     */
043    public LLPException(String msg) {
044        super(msg);
045    }
046
047    /**
048     * Constructs an <code>LLPException</code> with the specified detail message 
049     * and embedded exception.  
050     * @param msg the detail message.
051     * @param e an embedded exception (should normally represent the cause of the LLPException)
052     */
053    public LLPException(String msg, Exception e) {
054        /*
055         * Warning! Don't change the method signature to accept Throwable
056         * without being careful- getException(), which is historical now
057         * does a cast!
058         */
059        super(msg, e);
060    }
061
062    /** 
063     * Returns the embedded exception (if any) - this  
064     * would normally represent the underlying cause of this LLPException.  For example, 
065     * an UnsupportedEncodingException may be raised in a MinLowerLayerProtocol - if this  
066     * happened the MinLowerLayerProtocol would throw an LLPException, wrapping the original 
067     * UnsupportedEncodingException, and a call to <code>getException()</code> would return
068     * the UnsupportedEncodingException.
069     * 
070     * @deprecated Use {@link #getCause()}
071     */
072    public Exception getException() {
073        return (Exception) getCause();
074    }
075}
076
077