Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.x: Fix wrong description for bean validation annotations (#8505) #8556

Merged
merged 1 commit into from
Apr 16, 2024
Merged

4.x: Fix wrong description for bean validation annotations (#8505) #8556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions docs/src/main/asciidoc/mp/beanvalidation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Note that `double` and `float` are not supported due to rounding errors (some pr


|`@Max`
a|The annotated element must be a number whose value must be higher or equal to the specified minimum.
a|The annotated element must be a number whose value must be lower or equal to the specified maximum.

Supported types are:

Expand All @@ -117,12 +117,13 @@ Note that `double` and `float` are not supported due to rounding errors (some pr
`Null` elements are considered valid.

|`@DecimalMin`
a|The annotated element must be a number whose value must be lower or equal to the specified maximum.
a|The annotated element must be a number whose value must be higher or equal to the specified minimum.

Supported types are:

* `BigDecimal`
* `BigInteger`
* `CharSequence`
* `byte`, `short`, `int`, `long`, and their respective wrappers

Note that `double` and `float` are not supported due to rounding errors (some providers might provide some approximative support).
Expand All @@ -137,6 +138,7 @@ Supported types are:

* `BigDecimal`
* `BigInteger`
* `CharSequence`
* `byte`, `short`, `int`, `long`, and their respective wrappers

Note that `double` and `float` are not supported due to rounding errors (some providers might provide some approximative support).
Expand Down Expand Up @@ -212,7 +214,7 @@ Supported types are:


|`@Past`
a|The annotated element must be an instant, date or time in the past or in the present.
a|The annotated element must be an instant, date or time in the past.
`Now` is defined by the `ClockProvider` attached to the `Validator` or `ValidatorFactory`. The default `clockProvider` defines the current time
according to the virtual machine, applying the current default time zone if needed.

Expand Down Expand Up @@ -242,6 +244,10 @@ a|The annotated element must be an instant, date or time in the past or in the p
`Now` is defined by the `ClockProvider` attached to the `Validator` or `ValidatorFactory`. The default `clockProvider` defines the current time
according to the virtual machine, applying the current default time zone if needed.

The notion of present is defined relatively to the type on which the constraint is
used. For instance, if the constraint is on a `Year`, present would mean the whole
current year.

Supported types are:

* `java.util.Date`
Expand All @@ -263,7 +269,7 @@ Supported types are:

`Null` elements are considered valid.

|`@PastOrPresent`
|`@Future`
a|The annotated element must be an instant, date or time in the future.
`Now` is defined by the `ClockProvider` attached to the `Validator` or `ValidatorFactory`. The default `clockProvider` defines the current time
according to the virtual machine, applying the current default time zone if needed.
Expand Down Expand Up @@ -294,6 +300,10 @@ a|The annotated element must be an instant, date or time in the present or in th
`Now` is defined by the `ClockProvider` attached to the `Validator` or `ValidatorFactory`. The default `clockProvider` defines the current time
according to the virtual machine, applying the current default time zone if needed.

The notion of present here is defined relatively to the type on which the constraint is
used. For instance, if the constraint is on a `Year`, present would mean the whole
current year.

Supported types are:

* `java.util.Date`
Expand All @@ -315,7 +325,7 @@ Supported types are:

`Null` elements are considered valid.

|`@FutureOrPresent`
|`@Pattern`
a|The annotated `CharSequence` must match the specified regular expression.
The regular expression follows the Java regular expression conventions see `java.util.regex.Pattern`.
Accepts `CharSequence`.
Expand Down