001    /**
002    The 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. 
004    You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005    Software distributed under the License is distributed on an "AS IS" basis, 
006    WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007    specific language governing rights and limitations under the License. 
008    
009    The Original Code is "LLPException.java".  Description: 
010    "Represents a problem encountered while using a Lower Layer Protocol" 
011    
012    The Initial Developer of the Original Code is University Health Network. Copyright (C) 
013    2001.  All Rights Reserved. 
014    
015    Contributor(s): ______________________________________. 
016    
017    Alternatively, the contents of this file may be used under the terms of the 
018    GNU General Public License (the  �GPL�), in which case the provisions of the GPL are 
019    applicable instead of those above.  If you wish to allow use of your version of this 
020    file only under the terms of the GPL and not to allow others to use your version 
021    of this file under the MPL, indicate your decision by deleting  the provisions above 
022    and replace  them with the notice and other provisions required by the GPL License.  
023    If you do not delete the provisions above, a recipient may use your version of 
024    this file under either the MPL or the GPL. 
025    
026    */
027    
028    package 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")
037    public class LLPException extends Exception {
038    
039        private Exception embeddedException; 
040        /**
041         * Constructs an <code>LLPException</code> with the specified detail message.
042         * @param msg the detail message.
043         */
044        public LLPException(String msg) {
045            super(msg);
046        }
047    
048        /**
049         * Constructs an <code>LLPException</code> with the specified detail message 
050         * and embedded exception.  
051         * @param msg the detail message.
052         * @param e an embedded exception (should normally represent the cause of the LLPException)
053         */
054        public LLPException(String msg, Exception e) {
055            super(msg);
056            this.embeddedException = e;
057        }
058    
059        /** 
060         * Returns the embedded exception (if any) - this  
061         * would normally represent the underlying cause of this LLPException.  For example, 
062         * an UnsupportedEncodingException may be raised in a MinLowerLayerProtocol - if this  
063         * happened the MinLowerLayerProtocol would throw an LLPException, wrapping the original 
064         * UnsupportedEncodingException, and a call to <code>getException()</code> would return
065         * the UnsupportedEncodingException.  
066         */
067        public Exception getException() {
068            return this.embeddedException;
069        }
070    }
071    
072