https://github.com/vavr-io/vavr-beanvalidation2
Support for Bean Validation 2.0 (JSR 380)
https://github.com/vavr-io/vavr-beanvalidation2
Last synced: 14 days ago
JSON representation
Support for Bean Validation 2.0 (JSR 380)
- Host: GitHub
- URL: https://github.com/vavr-io/vavr-beanvalidation2
- Owner: vavr-io
- Created: 2018-02-05T19:19:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T14:51:39.000Z (about 2 years ago)
- Last Synced: 2023-08-12T16:10:39.788Z (almost 2 years ago)
- Language: Java
- Size: 52.7 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/vavr-io/vavr-beanvalidation2)
# Vavr-Beanvalidation 2.0
This module provides support for bean validation 2.0 (JSR380). Can be used with any service provider of the bean validation spec
e.g. `org.hibernate.validator:hibernate-validator`
Features:
- `@Size` for vavr's `Traversable`
- `@NotEmpty` for vavr's `Value`
- All available validations can be applied to nested Tuple Values. See example below
- All available validations can be applied to vavr's `Map`s and `Traversable`s
including `Multimap`s
- All available validations on nested collection element types now give proper feedback
as to where violations occurred (index for `Seq`s and key for `Map`s)
# Using the module
Add the dependency to your classpath. For maven:
```xml
io.vavr
vavr-beanvalidation2
0.10.0
```
For the bean validation service provider to pick it up the constraints must be registered.
Add the following to your `validation.xml`:
```xml
...
META-INF/constraints-vavr.xml
...
```
Or register via java config of your validation provider. See `javax.validation.Configuration#addMapping`.
Since it would be very tedious to register all the `ValueExtractor`s for the tuple elements by yourself,
configuration is automatically done for you via Java service loader.
The definition in `META-INF/services` is picked up by the validation service provider.
Now JSR 380 validations will work on vavr types. e.g.
```java
public class TestBean {
@Size(min = 1, max = 2)
private Seq<@Max(10) Integer> seqWithOneOrTwoDecimals = List.of(0);
@NotEmpty
private Either mustNotBeLeftOrNull = Either.right(42);
private Tuple3<@NotBlank String, @NotBlank String, @NotNull Integer> allElementsMustBeProvided =
Tuple.of("a", "x", 3);
@NotNull
@NotEmpty
private Map<@Pattern(regexp = "^[a-z]$") String, @NotBlank String> allCharKeysMustHaveNonBlankValues =
HashMap.of("a", "Alice");
// getters and setters
}
```
# Considerations/Limitations
- While it is possible to validate `Try` and `Lazy`, the usage of these monads for beanvalidation
is questionable. Furthermore if the nested value of `Lazy` is to be validated,
evaluation will be forced and thus defeating the purpose of `Lazy`.
- Validation of `io.vavr.control.Validation` is out of scope/undefined for obvious reasons.