Package jakarta.validation
Top level package of the Jakarta Bean Validation API.
The main runtime artifacts are:
Validation
: the entry point to bootstrap Jakarta Bean ValidationValidatorFactory
: the bootstrapped Jakarta Bean Validation engineValidator
: contract to validate beans and access the metadataConstraintViolation
: constraint violation report
Constraint
: annotation marking an annotation as being a constraintConstraintValidator
: interface implemented by the piece of code validating a given constraintReportAsSingleViolation
: marks a composed constraint as returning a single constraint violation report
Valid
: annotation marking an association as cascaded during validationGroupSequence
: defines a sequence of groups that should be validated sequentially
-
Interface Summary Interface Description BootstrapConfiguration Represents the user specified default configuration inMETA-INF/validation.xml
.ClockProvider Contract for obtaining theClock
used as the reference fornow
when validating the@Future
and@Past
constraints.Configuration<T extends Configuration<T>> Receives configuration information, selects the appropriate Jakarta Bean Validation provider and builds the appropriateValidatorFactory
.ConstraintValidator<A extends Annotation,T> Defines the logic to validate a given constraintA
for a given object typeT
.ConstraintValidatorContext Provides contextual data and operation when applying a given constraint validator.ConstraintValidatorContext.ConstraintViolationBuilder ConstraintViolation
builder allowing to optionally associate the violation report to a sub path.ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext Represents a container element node whose context is configurable (i.e.ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderDefinedContext Represents a container element node whose context is known (i.e.ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeContextBuilder Represents refinement choices for a container element node.ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext Represents a node whose context is configurable (i.e.ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderDefinedContext Represents a node whose context is known (i.e.ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeContextBuilder Represents refinement choices for a node which is in an iterable, e.g.ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext Represents a node whose context is configurable (i.e.ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext Represents a node whose context is known (i.e.ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder Represents refinement choices for a node which is in an iterable, e.g.ConstraintValidatorFactory Instantiates aConstraintValidator
instance based off its class.ConstraintViolation<T> Describes a constraint violation.MessageInterpolator Interpolates a given constraint violation message.MessageInterpolator.Context Information related to the interpolation context.ParameterNameProvider Provides names for method and constructor parameters.Path Represents the navigation path from an object to another in an object graph.Path.BeanNode Node representing a bean.Path.ConstructorNode Node representing a constructor.Path.ContainerElementNode Node representing an element in a generic container such asOptional
,List
orMap
.Path.CrossParameterNode Node representing the element holding cross-parameter constraints of a method or constructor.Path.MethodNode Node representing a method.Path.Node Represents an element of a navigation path.Path.ParameterNode Node representing a parameter of a method or constructor.Path.PropertyNode Node representing a property.Path.ReturnValueNode Node representing the return value of a method or constructor.Payload Payload type that can be attached to a given constraint declaration.TraversableResolver Contract determining if a property can be accessed by the Jakarta Bean Validation provider.ValidationProviderResolver Determines the list of Jakarta Bean Validation providers available in the runtime environmentValidator Validates bean instances.ValidatorContext Represents the context that is used to createValidator
instances.ValidatorFactory Factory returning initializedValidator
instances. -
Class Summary Class Description Validation This class is the entry point for Jakarta Bean Validation. -
Enum Summary Enum Description ConstraintTarget Defines the constraint target.ElementKind Enum of possible kinds of elements encountered in Jakarta Bean Validation. -
Exception Summary Exception Description ConstraintDeclarationException Exception raised if a constraint declaration is not legal.ConstraintDefinitionException Exception raised if a constraint definition is not legal.ConstraintViolationException Reports the result of constraint violations.GroupDefinitionException Exception raised if a group definition is not legal.NoProviderFoundException Exception raised if no Jakarta Bean Validation provider could be found.UnexpectedTypeException Exception raised in the case that the constraint validator resolution cannot determine a suitable validator for a given type.ValidationException Base exception of all Jakarta Bean Validation "unexpected" problems. -
Annotation Types Summary Annotation Type Description Constraint Marks an annotation as being a Jakarta Bean Validation constraint.GroupSequence Defines group sequence.OverridesAttribute Marks an attribute as overriding the attribute of a composing constraint.OverridesAttribute.List Defines severalOverridesAttribute
annotations on the same elementReportAsSingleViolation A constraint annotation hosting this annotation will return the composed annotation error report if any of the composing annotations fail.Valid Marks a property, method parameter or method return type for validation cascading.