KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > ristretto > imap > IMAPException


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is Ristretto Mail API.
15  *
16  * The Initial Developers of the Original Code are
17  * Timo Stich and Frederik Dietz.
18  * Portions created by the Initial Developers are Copyright (C) 2004
19  * All Rights Reserved.
20  *
21  * Contributor(s):
22  *
23  * Alternatively, the contents of this file may be used under the terms of
24  * either the GNU General Public License Version 2 or later (the "GPL"), or
25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26  * in which case the provisions of the GPL or the LGPL are applicable instead
27  * of those above. If you wish to allow use of your version of this file only
28  * under the terms of either the GPL or the LGPL, and not to allow others to
29  * use your version of this file under the terms of the MPL, indicate your
30  * decision by deleting the provisions above and replace them with the notice
31  * and other provisions required by the GPL or the LGPL. If you do not delete
32  * the provisions above, a recipient may use your version of this file under
33  * the terms of any one of the MPL, the GPL or the LGPL.
34  *
35  * ***** END LICENSE BLOCK ***** */
36 package org.columba.ristretto.imap;
37
38 /**
39  * Thrown whenever anything unexpected in the communication
40  * with the IMAP server happend.
41  *
42  * @author tstich
43  *
44  */
45 public class IMAPException extends Exception JavaDoc {
46     
47     /**
48      *
49      */
50     private static final long serialVersionUID = 1L;
51     
52     IMAPResponse response;
53     
54     /**
55      * Constructs the IMAPException.
56      *
57      */
58     public IMAPException() {
59     }
60     /**
61      * Constructs the IMAPException.
62      *
63      * @param arg0
64      * @param arg1
65      */
66     public IMAPException(String JavaDoc arg0, Throwable JavaDoc arg1) {
67         super(arg0, arg1);
68     }
69     
70     /**
71      * Constructs the IMAPException.
72      *
73      * @param s
74      */
75     public IMAPException( String JavaDoc s )
76     {
77         super(s );
78     }
79     
80     /**
81      * Constructs the IMAPException.
82      *
83      * @param response
84      */
85     public IMAPException( IMAPResponse response )
86     {
87         super(response.getResponseMessage());
88         this.response = response;
89     }
90
91     /**
92      * Constructs the IMAPException.
93      *
94      * @param cause
95      */
96     public IMAPException(Throwable JavaDoc cause) {
97         super(cause);
98     }
99
100     /**
101      * Gets the response of the IMAP server that caused
102      * the exception. If no response is available <code>
103      * null</code> is returned.
104      *
105      * @return the response that caused the exception.
106      */
107     public IMAPResponse getResponse() {
108         return response;
109     }
110     /**
111      * @see java.lang.Throwable#getMessage()
112      */
113     public String JavaDoc getMessage() {
114         if( response != null) return response.getResponseMessage();
115         else return super.getMessage();
116     }
117 }
Popular Tags