/*
 * Bean Validation API
 *
 * License: Apache License, Version 2.0
 * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
 */
package javax.validation;

import java.util.Locale;

import javax.validation.metadata.ConstraintDescriptor;

Interpolates a given constraint violation message.

Implementations should be as tolerant as possible on syntax errors. Implementations must be thread-safe.

Author:Emmanuel Bernard, Hardy Ferentschik
/** * Interpolates a given constraint violation message. * <p> * Implementations should be as tolerant as possible on syntax errors. * Implementations must be thread-safe. * * @author Emmanuel Bernard * @author Hardy Ferentschik */
public 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.

Params:
  • messageTemplate – the message to interpolate
  • context – contextual information related to the interpolation
Returns:interpolated error message
/** * Interpolates the message template based on the constraint validation context. * <p> * The locale is defaulted according to the {@code MessageInterpolator} * implementation. See the implementation documentation for more detail. * * @param messageTemplate the message to interpolate * @param context contextual information related to the interpolation * * @return interpolated error message */
String interpolate(String messageTemplate, Context context);
Interpolates the message template based on the constraint validation context. The Locale used is provided as a parameter.
Params:
  • messageTemplate – the message to interpolate
  • context – contextual information related to the interpolation
  • locale – the locale targeted for the message
Returns:interpolated error message
/** * Interpolates the message template based on the constraint validation context. * The {@code Locale} used is provided as a parameter. * * @param messageTemplate the message to interpolate * @param context contextual information related to the interpolation * @param locale the locale targeted for the message * * @return interpolated error message */
String interpolate(String messageTemplate, Context context, Locale locale);
Information related to the interpolation context.
/** * Information related to the interpolation context. */
interface Context {
Returns:ConstraintDescriptor corresponding to the constraint being validated
/** * @return {@link ConstraintDescriptor} corresponding to the constraint being * validated */
ConstraintDescriptor<?> getConstraintDescriptor();
Returns:value being validated
/** * @return value being validated */
Object getValidatedValue();
Returns an instance of the specified type allowing access to provider-specific APIs. If the Bean Validation provider implementation does not support the specified class, ValidationException is thrown.
Params:
  • type – the class of the object to be returned
Type parameters:
  • <T> – the type of the object to be returned
Throws:
Returns:an instance of the specified class
Since:1.1
/** * Returns an instance of the specified type allowing access to * provider-specific APIs. If the Bean Validation provider * implementation does not support the specified class, * {@link ValidationException} is thrown. * * @param type the class of the object to be returned * @param <T> the type of the object to be returned * @return an instance of the specified class * @throws ValidationException if the provider does not support the call * * @since 1.1 */
<T> T unwrap(Class<T> type); } }