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