Top Description Interfaces Annotations Classes Enums

[default module]

Package jakarta.validation

Top level package of the Jakarta Bean Validation API. The main runtime artifacts are:

jakarta.validation.Validation: the entry point to bootstrap Jakarta Bean Validation
jakarta.validation.ValidatorFactory: the bootstrapped Jakarta Bean Validation engine
jakarta.validation.Validator: contract to validate beans and access the metadata
jakarta.validation.ConstraintViolation: constraint violation report

The main constraint definition artifacts are:

jakarta.validation.Constraint: annotation marking an annotation as being a constraint
jakarta.validation.ConstraintValidator: interface implemented by the piece of code validating a given constraint
jakarta.validation.ReportAsSingleViolation: marks a composed constraint as returning a single constraint violation report

The main constraint declaration artifacts are:

jakarta.validation.Valid: annotation marking an association as cascaded during validation
jakarta.validation.GroupSequence: defines a sequence of groups that should be validated sequentially

Interface Summary

Modifier and Type	Interface and Description
public interface	BootstrapConfiguration Represents the user specified default configuration in `META-INF/validation.xml`.
public interface	ClockProvider Contract for obtaining the `Clock` used as the reference for `now` when validating the `@Future` and `@Past` constraints.
public interface	Configuration< the type of a provider-specific specialization of this contract T extends Configuration<T>> Receives configuration information, selects the appropriate Jakarta Bean Validation provider and builds the appropriate `ValidatorFactory`.
public interface	ConstraintValidator< the annotation type handled by an implementation A extends Annotation, the target type supported by an implementation T> Defines the logic to validate a given constraint `A` for a given object type `T`.
public interface	ConstraintValidatorContext Provides contextual data and operation when applying a given constraint validator.
public interface	ConstraintValidatorFactory Instantiates a `ConstraintValidator` instance based off its class.
public interface	ConstraintViolation< the type of the root bean T> Describes a constraint violation.
public interface	MessageInterpolator Interpolates a given constraint violation message.
public interface	ParameterNameProvider Provides names for method and constructor parameters.
public interface	Path Represents the navigation path from an object to another in an object graph.
public interface	Payload Payload type that can be attached to a given constraint declaration.
public interface	TraversableResolver Contract determining if a property can be accessed by the Jakarta Bean Validation provider.
public interface	ValidationProviderResolver Determines the list of Jakarta Bean Validation providers available in the runtime environment Jakarta Bean Validation providers are identified by the presence of `META-INF/services/jakarta.validation.spi.ValidationProvider` files following the Service Provider pattern described here.
public interface	Validator Validates bean instances.
public interface	ValidatorContext Represents the context that is used to create `Validator` instances.
public interface	ValidatorFactory Factory returning initialized `Validator` instances.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	Constraint Marks an annotation as being a Jakarta Bean Validation constraint.
public @interface	GroupSequence Defines group sequence.
public @interface	OverridesAttribute Marks an attribute as overriding the attribute of a composing constraint.
public @interface	ReportAsSingleViolation A constraint annotation hosting this annotation will return the composed annotation error report if any of the composing annotations fail.
public @interface	Valid Marks a property, method parameter or method return type for validation cascading.

Class Summary

Modifier and Type	Class and Description
public class	ConstraintDeclarationException Exception raised if a constraint declaration is not legal.
public class	ConstraintDefinitionException Exception raised if a constraint definition is not legal.
public class	ConstraintViolationException Reports the result of constraint violations.
public class	GroupDefinitionException Exception raised if a group definition is not legal.
public class	NoProviderFoundException Exception raised if no Jakarta Bean Validation provider could be found.
public class	UnexpectedTypeException Exception raised in the case that the constraint validator resolution cannot determine a suitable validator for a given type.
public class	Validation This class is the entry point for Jakarta Bean Validation.
public class	ValidationException Base exception of all Jakarta Bean Validation "unexpected" problems.

Enum Summary

Modifier and Type	Enum and Description
public enum	ConstraintTarget Defines the constraint target.
public enum	ElementKind Enum of possible kinds of elements encountered in Jakarta Bean Validation.