com.izforge.izpack.api.handler

Interface Prompt

All Known Implementing Classes:

AbstractPrompt

public interface Prompt

Prompts users for a value or informs them of something.

Author:

Tim Anderson

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Prompt.Option A prompt option.
static class	Prompt.Options Predefined options.
static class	Prompt.Type The prompt type.

Method Summary

Modifier and Type	Method and Description
Prompt.Option	confirm(Prompt.Type type, String message, Prompt.Options options) Displays a confirmation message.
Prompt.Option	confirm(Prompt.Type type, String message, Prompt.Options options, Prompt.Option defaultOption) Displays a confirmation message.
Prompt.Option	confirm(Prompt.Type type, String title, String message, Prompt.Options options) Displays a confirmation message.
Prompt.Option	confirm(Prompt.Type type, String title, String message, Prompt.Options options, Prompt.Option defaultOption) Displays a confirmation message.
void	error(String message) Displays an error message.
void	error(String title, String message) Displays an error message.
void	error(String title, String message, Throwable throwable) Displays an error message.
void	error(String message, Throwable throwable) Displays an error message.
void	error(Throwable throwable) Displays an error message.
void	message(Prompt.Type type, String message) Displays a message.
void	message(Prompt.Type type, String title, String message) Displays a message.
void	message(Prompt.Type type, String title, String message, Throwable throwable) Displays a message.
void	message(Throwable throwable) Displays a message.
void	warn(String message) Displays a warning message.
void	warn(String title, String message) Displays a warning message.
void	warn(Throwable throwable) Displays a warning message.

Method Detail

message

void message(Throwable throwable)

Displays a message.

Parameters:

throwable - the throwable for displaying details

message

void message(Prompt.Type type,
             String message)

Displays a message.

Parameters:

type - the type of the message

message - the message to display

message

void message(Prompt.Type type,
             String title,
             String message)

Displays a message.

Parameters:

type - the type of the message

title - the message title. If null, the title will be determined from the type

message - the message to display

message

void message(Prompt.Type type,
             String title,
             String message,
             Throwable throwable)

Displays a message.

Parameters:

type - the type of the message

title - the message title. If null, the title will be determined from the type

message - the message to display

throwable - the throwable for displaying details

warn

void warn(Throwable throwable)

Displays a warning message.

Parameters:

throwable - the throwable for displaying details

warn

void warn(String message)

Displays a warning message.

Parameters:

message - the message to display

warn

void warn(String title,
          String message)

Displays a warning message.

Parameters:

title - the message title. May be null

message - the message to display

error

void error(String message)

Displays an error message.

Parameters:

message - the message to display

error

void error(Throwable throwable)

Displays an error message.

Parameters:

throwable - the throwable for displaying details

error

void error(String message,
           Throwable throwable)

Displays an error message.

Parameters:

message - the message to display

throwable - the throwable for displaying details

error

void error(String title,
           String message)

Displays an error message.

Parameters:

title - the message title. May be null

message - the message display

error

void error(String title,
           String message,
           Throwable throwable)

Displays an error message.

Parameters:

title - the message title. May be null

message - the message display

throwable - the throwable for displaying details

confirm

Prompt.Option confirm(Prompt.Type type,
                      String message,
                      Prompt.Options options)

Displays a confirmation message.

Parameters:

type - the type of the message

message - the message

options - the options which may be selected

Returns:

the selected option

confirm

Prompt.Option confirm(Prompt.Type type,
                      String message,
                      Prompt.Options options,
                      Prompt.Option defaultOption)

Displays a confirmation message.

Parameters:

type - the type of the message

message - the message

options - the options which may be selected

defaultOption - the default option to select

Returns:

the selected option

confirm

Prompt.Option confirm(Prompt.Type type,
                      String title,
                      String message,
                      Prompt.Options options)

Displays a confirmation message.

Parameters:

type - the type of the message

title - the message title. May be null

message - the message

options - the options which may be selected

Returns:

the selected option

confirm

Prompt.Option confirm(Prompt.Type type,
                      String title,
                      String message,
                      Prompt.Options options,
                      Prompt.Option defaultOption)

Displays a confirmation message.

Parameters:

type - the type of the message

title - the message title. May be null

message - the message

options - the options which may be selected

defaultOption - the default option to select

Returns:

the selected option