org.hibernate.validator.messageinterpolation

Class AbstractMessageInterpolator

java.lang.Object

org.hibernate.validator.messageinterpolation.AbstractMessageInterpolator

All Implemented Interfaces:

MessageInterpolator

Direct Known Subclasses:

ParameterMessageInterpolator, ResourceBundleMessageInterpolator

public abstract class AbstractMessageInterpolator
extends Object
implements MessageInterpolator

Resource bundle backed message interpolator.

Since:

5.2

Author:

Emmanuel Bernard, Hardy Ferentschik, Gunnar Morling, Adam Stawicki, Marko Bekhta

Nested Class Summary

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

MessageInterpolator.Context

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTRIBUTOR_VALIDATION_MESSAGES Default name of the message bundle defined by a constraint definition contributor.
static String	USER_VALIDATION_MESSAGES The name of the user-provided message bundle as defined in the specification.

Constructor Summary

Constructors

Constructor and Description
AbstractMessageInterpolator()
AbstractMessageInterpolator(ResourceBundleLocator userResourceBundleLocator)
AbstractMessageInterpolator(ResourceBundleLocator userResourceBundleLocator, ResourceBundleLocator contributorResourceBundleLocator) MessageInterpolator taking two resource bundle locators.
AbstractMessageInterpolator(ResourceBundleLocator userResourceBundleLocator, ResourceBundleLocator contributorResourceBundleLocator, boolean cacheMessages) MessageInterpolator taking two resource bundle locators.

Method Summary

Modifier and Type	Method and Description
abstract String	interpolate(MessageInterpolator.Context context, Locale locale, String term)
String	interpolate(String message, MessageInterpolator.Context context) Interpolates the message template based on the constraint validation context.
String	interpolate(String message, MessageInterpolator.Context context, Locale locale) Interpolates the message template based on the constraint validation context.

Methods inherited from class java.lang.Object

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

Field Detail

USER_VALIDATION_MESSAGES

public static final String USER_VALIDATION_MESSAGES

The name of the user-provided message bundle as defined in the specification.

See Also:

Constant Field Values

CONTRIBUTOR_VALIDATION_MESSAGES

public static final String CONTRIBUTOR_VALIDATION_MESSAGES

Default name of the message bundle defined by a constraint definition contributor.

Since:

5.2

See Also:

Constant Field Values

Constructor Detail

AbstractMessageInterpolator

public AbstractMessageInterpolator()

AbstractMessageInterpolator

public AbstractMessageInterpolator(ResourceBundleLocator userResourceBundleLocator)

AbstractMessageInterpolator

public AbstractMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
                                   ResourceBundleLocator contributorResourceBundleLocator)

MessageInterpolator taking two resource bundle locators.

Parameters:

userResourceBundleLocator - ResourceBundleLocator used to load user provided resource bundle

contributorResourceBundleLocator - ResourceBundleLocator used to load resource bundle of constraint contributor

Since:

5.2

AbstractMessageInterpolator

public AbstractMessageInterpolator(ResourceBundleLocator userResourceBundleLocator,
                                   ResourceBundleLocator contributorResourceBundleLocator,
                                   boolean cacheMessages)

MessageInterpolator taking two resource bundle locators.

Parameters:

userResourceBundleLocator - ResourceBundleLocator used to load user provided resource bundle

contributorResourceBundleLocator - ResourceBundleLocator used to load resource bundle of constraint contributor

cacheMessages - Whether resolved messages should be cached or not.

Since:

5.2

Method Detail

interpolate

public String interpolate(String message,
                          MessageInterpolator.Context context)

Description copied from interface: MessageInterpolator

Interpolates the message template based on the constraint validation context.

The locale is defaulted according to the MessageInterpolator implementation. See the implementation documentation for more detail.

Specified by:

interpolate in interface MessageInterpolator

Parameters:

message - the message to interpolate

context - contextual information related to the interpolation

Returns:

interpolated error message

interpolate

public String interpolate(String message,
                          MessageInterpolator.Context context,
                          Locale locale)

Description copied from interface: MessageInterpolator

Interpolates the message template based on the constraint validation context. The Locale used is provided as a parameter.

Specified by:

interpolate in interface MessageInterpolator

Parameters:

message - the message to interpolate

context - contextual information related to the interpolation

locale - the locale targeted for the message

Returns:

interpolated error message

interpolate

public abstract String interpolate(MessageInterpolator.Context context,
                                   Locale locale,
                                   String term)