org.codehaus.groovy.grails.cli

Class CommandLineHelper

java.lang.Object

org.codehaus.groovy.grails.cli.CommandLineHelper

public class CommandLineHelper
extends java.lang.Object

Utility methods for use on the command line, including method to accept user input etc.

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
CommandLineHelper()
CommandLineHelper(java.io.InputStream input, java.io.PrintStream out) Deprecated. Use no-args constructor
CommandLineHelper(java.io.PrintStream out) Deprecated. Use no-args constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	userInput(java.lang.String message) Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries.
java.lang.String	userInput(java.lang.String message, java.lang.String[] validResponses) Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandLineHelper

public CommandLineHelper()

CommandLineHelper

@Deprecated
public CommandLineHelper(java.io.PrintStream out)

Deprecated. Use no-args constructor

CommandLineHelper

@Deprecated
public CommandLineHelper(java.io.InputStream input,
                            java.io.PrintStream out)

Deprecated. Use no-args constructor

Method Detail

userInput

public java.lang.String userInput(java.lang.String message)

Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries. Prints a message and returns whatever the user enters (once they press <return>).

Parameters:

message - The message/question to display.

Returns:

The line of text entered by the user. May be a blank string.

userInput

public java.lang.String userInput(java.lang.String message,
                         java.lang.String[] validResponses)

Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries. Prints a message and list of valid responses, then returns whatever the user enters (once they press <return>). If the user enters something that is not in the array of valid responses, the message is displayed again and the method waits for more input. It will display the message a maximum of three times before it gives up and returns null.

Parameters:

message - The message/question to display.

validResponses - An array of responses that the user is allowed to enter. Displayed after the message.

Returns:

The line of text entered by the user, or null if the user never entered a valid string.