KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > openide > util > UserQuestionException


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19 package org.openide.util;
20
21
22 /** Exception that is thrown when the process is about to perform some
23 * action that requires user confirmation. It can be useful when there
24 * is a call to a method which cannot open a dialog, but still would like
25 * to ask the user a question. It can raise this exception and higher level
26 * parts of the system can/should catch it and present a dialog to the user
27 * and if the user agrees reinvoke the action again.
28 * <P>
29 * The <code>getLocalizedMessage</code> method should return the user question,
30 * which will be shown to the user in a dialog with OK, Cancel options and
31 * if the user chooses OK, method <code>ex.confirmed ()</code> will be called.
32 *
33 * @author Jaroslav Tulach
34 */

35 public abstract class UserQuestionException extends java.io.IOException JavaDoc {
36     static final long serialVersionUID = -654358275349813705L;
37
38     /** Creates new exception UserQuestionException
39     */

40     public UserQuestionException() {
41         super();
42     }
43
44     /** Creates new exception UserQuestionException with text specified
45     * string s.
46     * @param s the text describing the exception
47     */

48     public UserQuestionException(String JavaDoc s) {
49         super(s);
50     }
51
52     /** Invoke the action if the user confirms the action.
53      * @exception IOException if another I/O problem exists
54      */

55     public abstract void confirmed() throws java.io.IOException JavaDoc;
56 }
57
Popular Tags