org.omnifaces.validator

Class JsfLabelMessageInterpolator

java.lang.Object

org.omnifaces.validator.JsfLabelMessageInterpolator

All Implemented Interfaces:

javax.validation.MessageInterpolator

public class JsfLabelMessageInterpolator
extends Object
implements javax.validation.MessageInterpolator

Bean Validation message interpolator that is able to insert the label of the component via which validation failed into the validation message. For this the special placeholder {jsf.label} can be used. This MessageInterpolator will replace every occurrence of that with the label of the current component.

Note that Bean Validation is not only called from within JSF, and as such JSF might not be available. If JSF is not available occurrences of {jsf.label} will be replaced by "nothing" (the empty string). The user should take care that messages are compatible with both situations if needed.

This message interpolator is NOT needed for putting a component label before or after a bean validation message. That functionality is already provided by JSF itself via the javax.faces.validator.BeanValidator.MESSAGE key in any resource bundle known to JSF.

Example

In ValidationMessages.properties

javax.validation.constraints.Size.message = The size of {jsf.label} must be between {min} and {max} characters

Installation

Create a META-INF/validation.xml file with the following contents:

 <?xml version="1.0" encoding="UTF-8"?>
 <validation-config
        xmlns="http://jboss.org/xml/ns/javax/validation/configuration"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://jboss.org/xml/ns/javax/validation/configuration validation-configuration-1.0.xsd">

        <message-interpolator>org.omnifaces.validator.JsfLabelMessageInterpolator</message-interpolator>

 </validation-config>
 

Since:

1.5

Author:

Arjan Tijms

Nested Class Summary

Nested classes/interfaces inherited from interface javax.validation.MessageInterpolator

javax.validation.MessageInterpolator.Context

Constructor Summary

Constructors

Constructor and Description
JsfLabelMessageInterpolator()

Method Summary

Methods

Modifier and Type	Method and Description
String	interpolate(String messageTemplate, javax.validation.MessageInterpolator.Context context)
String	interpolate(String messageTemplate, javax.validation.MessageInterpolator.Context context, Locale locale)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsfLabelMessageInterpolator

public JsfLabelMessageInterpolator()

Method Detail

interpolate

public String interpolate(String messageTemplate,
                 javax.validation.MessageInterpolator.Context context)

Specified by:

interpolate in interface javax.validation.MessageInterpolator

interpolate

public String interpolate(String messageTemplate,
                 javax.validation.MessageInterpolator.Context context,
                 Locale locale)

Specified by:

interpolate in interface javax.validation.MessageInterpolator