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 * @(#)FolderNotFoundException.java 1.8 07/05/04
39 */
40
41 package javax.mail;
42
43 import java.lang;
44
45 /**
46 * This exception is thrown by Folder methods, when those
47 * methods are invoked on a non existent folder.
48 *
49 * @author John Mani
50 */
51
52 public class FolderNotFoundException extends MessagingException {
53 transient private Folder folder;
54
55 private static final long serialVersionUID = 472612108891249403L;
56
57 /**
58 * Constructs a MessagingException with no detail message.
59 */
60 public FolderNotFoundException() {
61 super();
62 }
63
64 /**
65 * Constructs a MessagingException with the specified folder.
66 * @param folder the Folder
67 * @since JavaMail 1.2
68 */
69 public FolderNotFoundException(Folder folder) {
70 super();
71 this.folder = folder;
72 }
73
74 /**
75 * Constructs a MessagingException with the specified folder and
76 * the specified detail message.
77 * @param folder the Folder
78 * @param s the detail message
79 * @since JavaMail 1.2
80 */
81 public FolderNotFoundException(Folder folder, String s) {
82 super(s);
83 this.folder = folder;
84 }
85
86 /**
87 * Constructs a MessagingException with the specified detail message
88 * and the specified folder.
89 * @param s the detail message
90 * @param folder the Folder
91 */
92 public FolderNotFoundException(String s, Folder folder) {
93 super(s);
94 this.folder = folder;
95 }
96
97 /**
98 * Returns the offending Folder object.
99 * @return the Folder object. Note that the returned value can be
100 * <code>null</code>.
101 */
102 public Folder getFolder() {
103 return folder;
104 }
105 }