1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2000-2002 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45 package org.exolab.castor.util.dialog;
46
47 /**
48 * A simple utility class to handle user interaction.
49 *
50 * @author <a href="mailto:nsgreen@thazar.com">Nathan Green</a>
51 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
52 */
53 public interface Dialog {
54
55 /**
56 * Presents a confirmation prompt with the given message.
57 *
58 * @param message
59 * the confirmation prompt message to display
60 * @return true if the user has selected a positive confirmation, otherwise
61 * false
62 */
63 boolean confirm(final String message);
64
65 /**
66 * Presents a confirmation prompt for values with the given message.
67 *
68 * @param message
69 * the confirmation prompt to display
70 * @param values
71 * a list of valid characters to accept
72 * @return whatever character the user presses
73 */
74 char confirm(final String message, final String values);
75
76 /**
77 * Presents a confirmation prompt for values with the given messge.
78 *
79 * @param message
80 * the confirmation prompt to display
81 * @param values
82 * a list of valid characters to accept
83 * @param help
84 * a simple help message that can be associated with the message
85 * to give additional details about the prompt.
86 * @return whatever character the user presses
87 */
88 char confirm(final String message, final String values, final String help);
89
90 /**
91 * Simply displays a message to the user, no input is returned from the
92 * user.
93 *
94 * @param message
95 * the message to display to the user
96 */
97 void notify(final String message);
98
99 } //-- Dialog