Package javax.validation
Interface ValidatorFactory
- All Superinterfaces:
AutoCloseable
Factory returning initialized
Validator
instances.
Implementations are thread-safe and instances are typically cached and reused.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes theValidatorFactory
instance.Returns theClockProvider
instance configured at initialization time for theValidatorFactory
.Returns theConstraintValidatorFactory
instance configured at initialization time for theValidatorFactory
.Returns theMessageInterpolator
instance configured at initialization time for theValidatorFactory
.Returns theParameterNameProvider
instance configured at initialization time for theValidatorFactory
.Returns theTraversableResolver
instance configured at initialization time for theValidatorFactory
.Returns an initializedValidator
instance using the factory defaults for message interpolator, traversable resolver and constraint validator factory.<T> T
Returns an instance of the specified type allowing access to provider-specific APIs.Defines a new validator context and returns aValidator
compliant this new context.
-
Method Details
-
getValidator
Validator getValidator()Returns an initializedValidator
instance using the factory defaults for message interpolator, traversable resolver and constraint validator factory.Validator instances can be pooled and shared by the implementation.
- Returns:
- an initialized
Validator
instance
-
usingContext
ValidatorContext usingContext()Defines a new validator context and returns aValidator
compliant this new context.- Returns:
- a
ValidatorContext
instance
-
getMessageInterpolator
MessageInterpolator getMessageInterpolator()Returns theMessageInterpolator
instance configured at initialization time for theValidatorFactory
. This is the instance used bygetValidator()
.- Returns:
MessageInterpolator
instance
-
getTraversableResolver
TraversableResolver getTraversableResolver()Returns theTraversableResolver
instance configured at initialization time for theValidatorFactory
. This is the instance used bygetValidator()
.- Returns:
TraversableResolver
instance
-
getConstraintValidatorFactory
ConstraintValidatorFactory getConstraintValidatorFactory()Returns theConstraintValidatorFactory
instance configured at initialization time for theValidatorFactory
. This is the instance used bygetValidator()
.- Returns:
ConstraintValidatorFactory
instance
-
getParameterNameProvider
ParameterNameProvider getParameterNameProvider()Returns theParameterNameProvider
instance configured at initialization time for theValidatorFactory
. This is the instance used by #getValidator().- Returns:
ParameterNameProvider
instance- Since:
- 1.1
-
getClockProvider
ClockProvider getClockProvider()Returns theClockProvider
instance configured at initialization time for theValidatorFactory
. This is the instance used by #getValidator().- Returns:
ClockProvider
instance- Since:
- 2.0
-
unwrap
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, aValidationException
is thrown.- Type Parameters:
T
- the type of the object to be returned- Parameters:
type
- the class of the object to be returned- Returns:
- an instance of the specified class
- Throws:
ValidationException
- if the provider does not support the call.
-
close
void close()Closes theValidatorFactory
instance. After theValidatorFactory
instance is closed, calling the following methods is not allowed:- methods of this
ValidatorFactory
instance - methods of
Validator
instances created by thisValidatorFactory
- Specified by:
close
in interfaceAutoCloseable
- Since:
- 1.1
- methods of this
-