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 * @(#)ReadOnlyFolderException.java 1.7 07/05/04
39 */
40
41 package javax.mail;
42
43 /**
44 * This exception is thrown when an attempt is made to open a folder
45 * read-write access when the folder is marked read-only. <p>
46 *
47 * The getMessage() method returns more detailed information about the
48 * error that caused this exception. <p>
49 *
50 * @author Jim Glennon
51 */
52
53 public class ReadOnlyFolderException extends MessagingException {
54 transient private Folder folder;
55
56 private static final long serialVersionUID = 5711829372799039325L;
57
58 /**
59 * Constructs a MessagingException with the specified folder.
60 * @param folder the Folder
61 * @since JavaMail 1.2
62 */
63 public ReadOnlyFolderException(Folder folder) {
64 this(folder, null);
65 }
66
67 /**
68 * Constructs a MessagingException with the specified folder and
69 * the specified detail message.
70 * @param folder the Folder
71 * @param message the detailed error message
72 * @since JavaMail 1.2
73 */
74 public ReadOnlyFolderException(Folder folder, String message) {
75 super(message);
76 this.folder = folder;
77 }
78
79 /**
80 * Returns the dead Folder object.
81 * @since JavaMail 1.2
82 */
83 public Folder getFolder() {
84 return folder;
85 }
86 }