+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
+
+
Search
+
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:
+
+
j.l.obj will match "java.lang.Object"
+
InpStr will match "java.io.InputStream"
+
HM.cK will match "java.util.HashMap.containsKey(Object)"
+The following sections describe the different kinds of pages in this collection.
+
+
Overview
+
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
+
+
Interfaces
+
Classes
+
Enum Classes
+
Exceptions
+
Errors
+
Annotation Interfaces
+
+
+
+
Class or Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
+
+
Class Inheritance Diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class or Interface Declaration
+
Class or Interface Description
+
+
+
+
Nested Class Summary
+
Enum Constant Summary
+
Field Summary
+
Property Summary
+
Constructor Summary
+
Method Summary
+
Required Element Summary
+
Optional Element Summary
+
+
+
+
Enum Constant Details
+
Field Details
+
Property Details
+
Constructor Details
+
Method Details
+
Element Details
+
+
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
+
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Other Files
+
Packages and modules may contain pages with additional information related to the declarations nearby.
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The All Packages page contains an alphabetic index of all packages contained in the documentation.
+
+
+
All Classes and Interfaces
+
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
+
+
+
Index
+
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
In case of using this constraint validator with jakarta.validation.ConstraintValidator returns null, because JRS-303 doesn't
+ support passing a root bean in their validation context.
+
+
getSize(T) - Method in interface io.micronaut.validation.validator.constraints.SizeValidator
handle in interface io.micronaut.http.server.exceptions.ExceptionHandler<jakarta.validation.ConstraintViolationException,io.micronaut.http.HttpResponse<?>>
@Internal
+public class DefaultAnnotatedElementValidator
+extends DefaultValidator
+implements io.micronaut.inject.annotation.AnnotatedElementValidator
+
Default implementation of AnnotatedElementValidator. Used for discovery via
+ service loader and not for direct public consumption. Considered internal.
+
+
Since:
+
1.2
+
Author:
+
graemerocher
+
+
+
+
+
+
+
+
Field Summary
+
+
Fields inherited from interface io.micronaut.inject.validation.BeanDefinitionValidator
+DEFAULT
+
+
Fields inherited from interface io.micronaut.validation.validator.Validator
Validate the given publisher by returning a new Publisher that validates each emitted value. If a
+ constraint violation error occurs a ConstraintViolationException will be thrown.
Validate the given CompletionStage by returning a new CompletionStage that validates the emitted value. If a
+ constraint violation error occurs a ConstraintViolationException will be thrown.
Validate the given publisher by returning a new Publisher that validates each emitted value. If a
+ constraint violation error occurs a ConstraintViolationException will be thrown.
Validate the given CompletionStage by returning a new CompletionStage that validates the emitted value. If a
+ constraint violation error occurs a ConstraintViolationException will be thrown.
Validates all constraints placed on the property of object
+ named propertyName.
+
+
Type Parameters:
+
T - the type of the object to validate
+
Parameters:
+
object - object to validate
+
propertyName - property to validate (i.e. field and getter constraints)
+
context - The context
+
Returns:
+
constraint violations or an empty set if none
+
Throws:
+
IllegalArgumentException - if object is null,
+ if propertyName is null, empty or not a valid object property
+ or if null is passed to the varargs groups
+
jakarta.validation.ValidationException - if a non recoverable error happens
+ during the validation process
Validates all constraints placed on the property named propertyName
+ of the class beanType would the property value be value.
+
+ ConstraintViolation objects return null for
+ ConstraintViolation.getRootBean() and
+ ConstraintViolation.getLeafBean().
+
+
Type Parameters:
+
T - the type of the object to validate
+
Parameters:
+
beanType - the bean type
+
propertyName - property to validate
+
value - property value to validate
+
context - The context
+
Returns:
+
constraint violations or an empty set if none
+
Throws:
+
IllegalArgumentException - if beanType is null,
+ if propertyName is null, empty or not a valid object property
+ or if null is passed to the varargs groups
+
jakarta.validation.ValidationException - if a non recoverable error happens
+ during the validation process
Constructs a new default instance. Note that the returned instance will not contain
+ managed ConstraintValidator instances and using
+ Inject should be preferred.
Constraint validator that can be used at either runtime or compilation time and
+ is capable of validation Constraint instances. Allows defining validators that work with both Hibernate validator and Micronaut's validator.
+
+
Unlike the specification's interface this one can uses as a functional interface. Implementor should not implement the ConstraintValidator.initialize(Annotation) method and should instead read the passed AnnotationValue.
In case of using this constraint validator with jakarta.validation.ConstraintValidator returns null, because JRS-303 doesn't
+ support passing a root bean in their validation context.
Returns the provider for obtaining the current time in the form of a Clock,
+ e.g. when validating the Future and Past constraints.
+
+
Specified by:
+
getClockProvider in interface jakarta.validation.ConstraintValidatorContext
+
Returns:
+
the provider for obtaining the current time, never null. If no
+ specific provider has been configured during bootstrap, a default implementation using
+ the current system time and the current default time zone as returned by
+ Clock.systemDefaultZone() will be returned.
In case of using this constraint validator with jakarta.validation.ConstraintValidator returns null, because JRS-303 doesn't
+ support passing a root bean in their validation context.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
A factory bean that contains implementation for many of the default validations.
+ This approach is preferred as it generates fewer classes and smaller byte code than defining a
+ validator class for each case.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
@Internal
+public class ValidationVisitor
+extends Object
+implements io.micronaut.inject.visitor.TypeElementVisitor<Object,Object>
+
The visitor creates annotations utilized by the Validator.
+ It adds @RequiresValidation annotation to fields if they require validation, and to methods
+ if one of the parameters or return value require validation.
+
+
Since:
+
4.0.0
+
Author:
+
Denis Stepanov
+
+
+
+
+
+
+
+
Nested Class Summary
+
+
Nested classes/interfaces inherited from interface io.micronaut.inject.visitor.TypeElementVisitor
DefaultMessageInterpolator(MessageSource, InterpolatorLocaleResolver)instead.