org.apache.deltaspike.jsf.api.message

Interface JsfMessage<T>

All Superinterfaces:

Serializable

public interface JsfMessage<T>
extends Serializable

An injectable component for typesafe FacesMessages. T must be a class which is annotated with org.apache.deltaspike.core.api.message.MessageBundle

Usage:

 @Inject
 JsfMessage<MyMessages> msg;
 ...
 msg.addError().userNotLoggedIn(user);
 

MessageBundle methods which are used as JsfMessage can return a org.apache.deltaspike.core.api.message.Message or a String. In case of a String we use it for both the summary and detail information on the FacesMessage.

If a Message is returned, we lookup the 'detail' and 'summary' categories (see org.apache.deltaspike.core.api.message.Message#toString(String) for creating the FacesMessage.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_DETAIL
static String	CATEGORY_SUMMARY

Method Summary

Methods

Modifier and Type	Method and Description
T	addError()
T	addFatal()
T	addInfo()
T	addWarn()
JsfMessage<T>	forClientId(String clientId) If the JsfMessage is used in a UIComponent we allow to set the clientId
JsfMessage<T>	forComponent(javax.faces.component.UIComponent uiComponent)
T	get()

Field Detail

CATEGORY_DETAIL

static final String CATEGORY_DETAIL

See Also:

Constant Field Values

CATEGORY_SUMMARY

static final String CATEGORY_SUMMARY

See Also:

Constant Field Values

Method Detail

forClientId

JsfMessage<T> forClientId(String clientId)

If the JsfMessage is used in a UIComponent we allow to set the clientId

Parameters:

clientId -

forComponent

JsfMessage<T> forComponent(javax.faces.component.UIComponent uiComponent)

Parameters:

uiComponent -

addError

T addError()

Returns:

the underlying Message which will automatically add a FacesMessage with SEVERITY_ERROR

addFatal

T addFatal()

Returns:

the underlying Message which will automatically add a FacesMessage with SEVERITY_FATAL

addInfo

T addInfo()

Returns:

the underlying Message which will automatically add a FacesMessage with SEVERITY_INFO

addWarn

T addWarn()

Returns:

the underlying Message which will automatically add a FacesMessage with SEVERITY_WARN

get

T get()

Returns:

the underlying Message implementation without adding any FacesMessage