01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.openide.util;
42:
43: /** Exception that is thrown when the process is about to perform some
44: * action that requires user confirmation. It can be useful when there
45: * is a call to a method which cannot open a dialog, but still would like
46: * to ask the user a question. It can raise this exception and higher level
47: * parts of the system can/should catch it and present a dialog to the user
48: * and if the user agrees reinvoke the action again.
49: * <P>
50: * The <code>getLocalizedMessage</code> method should return the user question,
51: * which will be shown to the user in a dialog with OK, Cancel options and
52: * if the user chooses OK, method <code>ex.confirmed ()</code> will be called.
53: *
54: * @author Jaroslav Tulach
55: */
56: public abstract class UserQuestionException extends java.io.IOException {
57: static final long serialVersionUID = -654358275349813705L;
58:
59: /** Creates new exception UserQuestionException
60: */
61: public UserQuestionException() {
62: super ();
63: }
64:
65: /** Creates new exception UserQuestionException with text specified
66: * string s.
67: * @param s the text describing the exception
68: */
69: public UserQuestionException(String s) {
70: super (s);
71: }
72:
73: /** Invoke the action if the user confirms the action.
74: * @exception IOException if another I/O problem exists
75: */
76: public abstract void confirmed() throws java.io.IOException;
77: }
|