https://github.com/ivanjermakov/jtrue
JTrue - a Java validation library
https://github.com/ivanjermakov/jtrue
Last synced: 2 months ago
JSON representation
JTrue - a Java validation library
- Host: GitHub
- URL: https://github.com/ivanjermakov/jtrue
- Owner: ivanjermakov
- License: mit
- Created: 2019-09-18T18:50:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-16T09:33:24.000Z (about 5 years ago)
- Last Synced: 2025-01-02T08:32:47.868Z (4 months ago)
- Language: Java
- Homepage:
- Size: 631 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JTrue: Java object validation library
[](https://travis-ci.com/ivanjermakov/jtrue)
[](https://codecov.io/gh/ivanjermakov/jtrue)
[](https://jitpack.io/#ivanjermakov/jtrue)
JTrue - Java functional-style lazy object validation library.
## Getting started
### Setting up the dependency
The first step is to include JTrue into your project, for example, as a Gradle dependency:
1. Add it in your root build.gradle at the end of repositories
```
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
2. Add the dependency
```
dependencies {
implementation 'com.github.ivanjermakov:jtrue:Tag'
}
```
### Hello world
Let's rule if given string is blank:
```
new Validator()
.rule(new NotBlank())
.validate("Hello, World!");
//output: true
```
### Base classes
JTrue features several base classes you can use:
* `Validatable`: base interface for all validators
* `Validator`: lazy functional-style implementation of `Validatable`
* `Rule`: smallest unit representing single validation predicate
* `RuleResult`: `Rule`, but tested on specific instance
All of them are located in `core` package.
### Predefined common-use predicates
In Hello world example, line `new Blank()` may caught your eye. It is one of predefined predicates. All of them located in `predicate` package. There are such predicates like: `Equals`, `EmptyString`, `Null` and many more.
## Bugs and feedback
[GitHub issues](https://github.com/ivanjermakov/jtrue/issues)
## Documentation
[JavaDoc](https://ivanjermakov.github.io/jtrue/docs/)
## Binaries
Binaries and dependency information for Maven, Gradle and others can be found on [JitPack page](https://jitpack.io/#ivanjermakov/jtrue).
## Build
To build:
```
$ git clone https://github.com/ivanjermakov/jtrue.git
$ gradle build
```
## LICENSE
```
MIT License
Copyright (c) 2019 Ivan Ermakov
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.
```