org.apache.unomi.shell.migration.utils

Class ConsoleUtils

java.lang.Object

org.apache.unomi.shell.migration.utils.ConsoleUtils

public class ConsoleUtils
extends Object

Author:

dgaillard

Constructor Summary

Constructors

Constructor and Description
ConsoleUtils()

Method Summary

Modifier and Type	Method and Description
static String	askUserWithAuthorizedAnswer(org.apache.karaf.shell.api.console.Session session, String msg, List<String> authorizedAnswer) This method allow you to ask a question to the user.
static String	askUserWithDefaultAnswer(org.apache.karaf.shell.api.console.Session session, String msg, String defaultAnswer) This will ask a question to the user and return the default answer if the user does not answer.
static void	printException(org.apache.karaf.shell.api.console.Session session, String msg, Throwable t) Print an exception along with a message in the console.
static void	printMessage(org.apache.karaf.shell.api.console.Session session, String msg) Print a message in the console.
static String	promptMessageToUser(org.apache.karaf.shell.api.console.Session session, String msg) This method allow you to prompt a message to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleUtils

public ConsoleUtils()

Method Detail

askUserWithDefaultAnswer

public static String askUserWithDefaultAnswer(org.apache.karaf.shell.api.console.Session session,
                                              String msg,
                                              String defaultAnswer)
                                       throws IOException

This will ask a question to the user and return the default answer if the user does not answer.

Parameters:

session - the shell's session

msg - String message to ask

defaultAnswer - String default answer

Returns:

the user's answer

Throws:

IOException - if there was a problem reading input from the console

askUserWithAuthorizedAnswer

public static String askUserWithAuthorizedAnswer(org.apache.karaf.shell.api.console.Session session,
                                                 String msg,
                                                 List<String> authorizedAnswer)
                                          throws IOException

This method allow you to ask a question to the user. The answer is controlled before being return so the question will be ask until the user enter one the authorized answer

Parameters:

session - the shell's session

msg - String message to ask

authorizedAnswer - Array of possible answer, all answer must be in lower case

Returns:

the user answer

Throws:

IOException - if there was an error retrieving an answer from the user on the console

promptMessageToUser

public static String promptMessageToUser(org.apache.karaf.shell.api.console.Session session,
                                         String msg)
                                  throws IOException

This method allow you to prompt a message to the user. No control is done on the answer provided by the user.

Parameters:

session - the shell's session

msg - String message to prompt

Returns:

the user answer

Throws:

IOException - if there was an error retrieving an answer from the user on the console

printMessage

public static void printMessage(org.apache.karaf.shell.api.console.Session session,
                                String msg)

Print a message in the console.

Parameters:

session - the shell's session

msg - the message to print out with a newline

printException

public static void printException(org.apache.karaf.shell.api.console.Session session,
                                  String msg,
                                  Throwable t)

Print an exception along with a message in the console.

Parameters:

session - the shell's session

msg - the message to print out with a newline

t - the exception to dump in the shell console after the message