https://github.com/thiagodnf/jvalidation
A simple, fast and light-weight validation tool to express pre- and post-conditions in your java code
https://github.com/thiagodnf/jvalidation
design-by-contract java java-validation maven preconditions validation
Last synced: about 1 year ago
JSON representation
A simple, fast and light-weight validation tool to express pre- and post-conditions in your java code
- Host: GitHub
- URL: https://github.com/thiagodnf/jvalidation
- Owner: thiagodnf
- License: mit
- Created: 2019-02-25T02:30:45.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T02:09:11.000Z (over 1 year ago)
- Last Synced: 2025-01-23T15:36:15.610Z (about 1 year ago)
- Topics: design-by-contract, java, java-validation, maven, preconditions, validation
- Language: Java
- Homepage:
- Size: 602 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A simple, fast and light-weight validation tool to express pre- and post-conditions in your java code
## Status
[](https://travis-ci.org/thiagodnf/jvalidation)
[](https://codecov.io/gh/thiagodnf/jvalidation)
[](https://opensource.org/licenses/mit-license.php)
[](https://github.com/ellerbrock/open-source-badges/)
## Features
- Simple and Complex rules
- More than 100 (fully tested) validators
- Works on Java 21+
## How to install
This project uses GitHub as a Maven Repository. Then you have just add the following section to your repositories tag in pom.xml
```xml
jvalidation-github
https://github.com/thiagodnf/mvn-repo/raw/master/releases
```
Then add a dependency into tag of your pom.xml
```xml
thiagodnf.jvalidation
jvalidation
1.6.0
```
## How to use
You have to statically import the library entry point:
```java
import static org.jvalidation.Assertive.*
```
Use assertive preconditions to check for programming errors in calling clients:
```java
require(i).isInteger().greaterThan(2);
```
Use assertive postconditions to check for programming errors in your supplied code:
```java
ensure(i).isString().notNull();
```
## Example
This is a simple example how to use the jvalidation
```java
import static org.jvalidation.Assertive.require
public int myMethod(String s, int j) {
require(s).isString().notNull(2);
require(j).isInteger().greaterThanOrEqualTo(2);
// your code here
ensure(s).isString().size(2);
return j;
}
```
Example of complex rule:
```java
import static org.jvalidation.Assertive.require
public int myMethod(int i) {
require(i).isInteger().even().greaterThanOrEqualTo(10);
// your code here
return 2;
}
```
## Matchers
This project uses the concept of matchers in which each one is responsible for validating a specific object. Each one has its own validation method. The available matchers (you can click to see the available methods) are shown as follows:
- [ObjectMatcher](https://github.com/jvalidation/jvalidation/wiki/ObjectMatcher)
- [IntegerMatcher](https://github.com/jvalidation/jvalidation/wiki/IntegerMatcher)
- [DoubleMatcher](https://github.com/jvalidation/jvalidation/wiki/DoubleMatcher)
- [StringMatcher](https://github.com/jvalidation/jvalidation/wiki/StringMatcher)
- [CharMatcher](https://github.com/jvalidation/jvalidation/wiki/CharMatcher)
- [ListMatcher](https://github.com/jvalidation/jvalidation/wiki/ListMatcher)
## Contributions
Feel free to fork this project, work on it and then make a pull request.
## Questions or Suggestions
Feel free to create issues here as you need
## License
MIT License
Copyright (c) 2019 Thiago Ferreira
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.