1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 /*
38 * @(#)FolderClosedException.java 1.7 07/05/04
39 */
40
41 package javax.mail;
42
43 /**
44 * This exception is thrown when a method is invoked on a Messaging object
45 * and the Folder that owns that object has died due to some reason. <p>
46 *
47 * Following the exception, the Folder is reset to the "closed" state.
48 * All messaging objects owned by the Folder should be considered invalid.
49 * The Folder can be reopened using the "open" method to reestablish the
50 * lost connection. <p>
51 *
52 * The getMessage() method returns more detailed information about the
53 * error that caused this exception. <p>
54 *
55 * @author John Mani
56 */
57
58 public class FolderClosedException extends MessagingException {
59 transient private Folder folder;
60
61 private static final long serialVersionUID = 1687879213433302315L;
62
63 /**
64 * Constructor
65 * @param folder the Folder
66 */
67 public FolderClosedException(Folder folder) {
68 this(folder, null);
69 }
70
71 /**
72 * Constructor
73 * @param folder the Folder
74 * @param message the detailed error message
75 */
76 public FolderClosedException(Folder folder, String message) {
77 super(message);
78 this.folder = folder;
79 }
80
81 /**
82 * Returns the dead Folder object
83 */
84 public Folder getFolder() {
85 return folder;
86 }
87 }
Save This Page