javax.validation.ValidatorContext Maven / Gradle / Ivy

Go to download
package javax.validation;

/**
 * Represents the context that is used to create Validator
 * instances.
 *
 * A client may use methods of the ValidatorContext returned through
 * usingContext of ValidatorFactory to customize
 * the context (for instance establish different message interpolators or
 * traversable resolvers) used to create Validator instances.
 * 
 * @author Emmanuel Bernard
 */
public interface ValidatorContext {
	/**
	 * Defines the message interpolator implementation used by the Validator.
	 * If not set or if null is passed as a parameter,
	 * the message interpolator of the ValidatorFactory is used.
	 *
	 * @return self following the chaining method pattern
	 */
	ValidatorContext messageInterpolator(MessageInterpolator messageInterpolator);

	/**
	 * Defines the traversable resolver implementation used by the Validator.
	 * If not set or if null is passed as a parameter,
	 * the traversable resolver of the ValidatorFactory is used.
	 *
	 * @return self following the chaining method pattern
	 */
	ValidatorContext traversableResolver(TraversableResolver traversableResolver);

	/**
	 * @return an initialized Validator instance respecting the defined state.
	 * Validator instances can be pooled and shared by the implementation.
	 */
	Validator getValidator();
}