sirius.web.controller

Class Message

java.lang.Object

sirius.web.controller.Message

public class Message
extends Object

Used by the UserContext to collect error or success messages.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR Declares a message as error.
static String	INFO Declares a message as information.
static String	SUCCESS Declares a message as success.
static String	WARN Declares a message as warning.

Constructor Summary

Constructors

Constructor and Description
Message() Creates a new empty message.
Message(String message, String details, String type) Creates a new message with the given content, details info and message type.

Method Summary

Modifier and Type	Method and Description
static Message	error(String message) Factory method to create an error message
static Message	error(Throwable t) Factory method to create an error message
String	getAction() Returns the action associated with the message
String	getActionLabel() Returns the label to be used for the action
String	getDetails() Returns detailed infos for this message
String	getMessage() Returns the message for the user.
String	getType() Returns the type of the message
static Message	info(String message) Factory method to create a info message
boolean	isActionJavascript() Determines if the action is an URL or a piece of JavaScript
void	setAction(String action)
void	setActionJavascript(boolean actionJavascript)
void	setActionLabel(String actionLabel)
void	setDetails(String details)
void	setMessage(String message)
void	setType(String type)
static Message	success(String message) Factory method to create a success message
String	toString()
static Message	warn(String message) Factory method to create a warning as message
Message	withAction(String link, String label) Adds an action as URL to the message
Message	withJavascriptAction(String codeFragment, String label) Adds an action as URL to the message

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final String SUCCESS

Declares a message as success.

See Also:

Constant Field Values

INFO

public static final String INFO

Declares a message as information.

See Also:

Constant Field Values

WARN

public static final String WARN

Declares a message as warning.

See Also:

Constant Field Values

ERROR

public static final String ERROR

Declares a message as error.

See Also:

Constant Field Values

Constructor Detail

Message

public Message(String message,
               String details,
               String type)

Creates a new message with the given content, details info and message type.

Parameters:

message - the message to show to the user

details - the details for this message

type - the type for the message

Message

public Message()

Creates a new empty message.

Method Detail

getMessage

public String getMessage()

Returns the message for the user.

Returns:

the message to show

getDetails

public String getDetails()

Returns detailed infos for this message

Returns:

the details to show to the user

getType

public String getType()

Returns the type of the message

Returns:

the type (one of SUCCESS, INFO, WARN, ERROR)

getAction

public String getAction()

Returns the action associated with the message

Returns:

a URL which will be invoked when the user clicks on the message

getActionLabel

public String getActionLabel()

Returns the label to be used for the action

Returns:

the label for the action which is shown to the user

isActionJavascript

public boolean isActionJavascript()

Determines if the action is an URL or a piece of JavaScript

Returns:

true if it is JS, false otherwise

withAction

public Message withAction(String link,
                          String label)

Adds an action as URL to the message

Parameters:

link - the URL to invoke if the user clicks on the message

label - the label to use for the given action

Returns:

the message itself for further use

withJavascriptAction

public Message withJavascriptAction(String codeFragment,
                                    String label)

Adds an action as URL to the message

Parameters:

codeFragment - the URL to invoke if the user clicks on the message

label - the label to use for the given action

Returns:

the message itself for further use

toString

public String toString()

Overrides:

toString in class Object

success

public static Message success(String message)

Factory method to create a success message

Parameters:

message - the message content

Returns:

a new message with the given content and SUCCESS as type

info

public static Message info(String message)

Factory method to create a info message

Parameters:

message - the message content

Returns:

a new message with the given content and INFO as type

warn

public static Message warn(String message)

Factory method to create a warning as message

Parameters:

message - the message content

Returns:

a new message with the given content and WARN as type

error

public static Message error(String message)

Factory method to create an error message

Parameters:

message - the message content

Returns:

a new message with the given content and ERROR as type

error

public static Message error(Throwable t)

Factory method to create an error message

Parameters:

t - the exception containing the error message

Returns:

a new message with the given content and ERROR as type

setMessage

public void setMessage(String message)

setDetails

public void setDetails(String details)

setType

public void setType(String type)

setAction

public void setAction(String action)

setActionLabel

public void setActionLabel(String actionLabel)

setActionJavascript

public void setActionJavascript(boolean actionJavascript)