org.codehaus.plexus.components.interactivity

Interface InputHandler

All Known Implementing Classes:

AbstractInputHandler, DefaultInputHandler, JLineInputHandler

public interface InputHandler

Manage user input from different sources.

Version:

$Id: InputHandler.java 2649 2005-10-10 16:51:51Z brett $

Author:

Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE

Method Summary

Modifier and Type	Method and Description
String	readLine() Read a single line of input, swalling the newline at the end.
List	readMultipleLines() Read a set of lines.
String	readPassword() Read a single line of input, swalling the newline at the end.

Field Detail

ROLE

static final String ROLE

Method Detail

readLine

String readLine()
         throws IOException

Read a single line of input, swalling the newline at the end. If the input can be echoed, it will be.

Returns:

the line read

Throws:

IOException

readPassword

String readPassword()
             throws IOException

Read a single line of input, swalling the newline at the end. This method guarantees input is not echoed.

Returns:

the line read

Throws:

IOException

readMultipleLines

List readMultipleLines()
                throws IOException

Read a set of lines. Equivalent to multiple calls to readLine(). Ends when an empty line is encountered.

Returns:

a list of lines read

Throws:

IOException