Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myconsciousness/precondition-validator
The Precondition Validator provides a variety of easy and intuitive validation functions. The features in this package will free you from simple and redundant checking processes.
https://github.com/myconsciousness/precondition-validator
gradle java library package precondition-validator preconditions utility validation validator
Last synced: 4 days ago
JSON representation
The Precondition Validator provides a variety of easy and intuitive validation functions. The features in this package will free you from simple and redundant checking processes.
- Host: GitHub
- URL: https://github.com/myconsciousness/precondition-validator
- Owner: myConsciousness
- License: apache-2.0
- Created: 2020-09-25T05:22:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-06T00:22:11.000Z (over 3 years ago)
- Last Synced: 2024-10-19T09:17:40.415Z (3 months ago)
- Topics: gradle, java, library, package, precondition-validator, preconditions, utility, validation, validator
- Language: Java
- Homepage: https://myconsciousness.github.io/precondition-validator/org/thinkit/common/Preconditions.html
- Size: 1.08 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# 1. Precondition Validator
**Table of Contents**
- [1.1. What is it?](#11-what-is-it)
- [1.2. Benefits](#12-benefits)
- [1.3. How To Use](#13-how-to-use)
- [1.3.1. Add the dependencies](#131-add-the-dependencies)
- [1.3.2. Add an import for **_Preconditions_**](#132-add-an-import-for-_preconditions_)
- [1.3.3. Define preconditions](#133-define-preconditions)
- [1.4. License](#14-license)
- [1.5. More Information](#15-more-information)
## 1.1. What is it?
**_Make your software more robust by defining clear preconditions!_**
`Precondition Validator` provides several features to ensure that the parameters and data passed at the start of the process meet the preconditions.
Using the `Precondition Validator` features, you can safely and easily specify preconditions at the start of the process.
## 1.2. Benefits
- No need to write a redundant validation process for preconditions
- Tested and secure validation process
- Easy and intuitive operation
## 1.3. How To Use
### 1.3.1. Add the dependencies
> **_Note:_**
> Replace version you want to use. Check the latest [Packages](https://github.com/myConsciousness/precondition-validator/packages).
> Please contact me for a token to download the package.
**_Maven_**
```xml
org.thinkit.common
precondition-validator
v1.1.1
github
myConsciousness
xxxxxxxxxxxxxxxxxx
```
**_Gradle_**
```gradle
repositories {
maven {
name = "GitHubPackages"
url = uri("https://maven.pkg.github.com/myConsciousness/precondition-validator")
credentials {
username = "myConsciousness"
password = "xxxxxxxxxxxxxxxxxx"
}
}
}
dependencies {
implementation 'org.thinkit.common:precondition-validator:v1.1.1'
}
```
### 1.3.2. Add an import for [**_Preconditions_**](https://myconsciousness.github.io/precondition-validator/org/thinkit/common/base/precondition/Preconditions.html)
```java
import org.thinkit.common.base.precondition.Preconditions;
```
### 1.3.3. Define preconditions
The following is an example using [Preconditions#requireNonEmpty(Object[])]() and [Preconditions#requireNonEmpty(String)]().
> **_Note:_**
> The reference for all validation methods is [here](https://myconsciousness.github.io/precondition-validator/org/thinkit/common/base/precondition/Preconditions.html).
```java
import org.thinkit.common.base.precondition.Preconditions;
public class DemoPreconditions {
/**
* Entry point for app that are expected to be given a non-empty string...
*/
public static void main(String[] args) {
// Validate that args is not an empty array
// and that args[0] is not an empty string.
Preconditions.requireNonEmpty(args);
Preconditions.requireNonEmpty(args[0]);
}
}
```
## 1.4. License
```
Copyright 2020 Kato Shinya.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License.
```
## 1.5. More Information
`Precondition Validator` was designed and implemented by Kato Shinya, who works as a freelance developer.
Regardless of the means or content of communication, I would love to hear from you if you have any questions or concerns. I do not check my email box very often so a response may be delayed, anyway thank you for your interest!
- [Creator Profile](https://github.com/myConsciousness)
- [Creator Website](https://myconsciousness.github.io/)
- [License](https://github.com/myConsciousness/precondition-validator/blob/master/LICENSE)
- [Release Note](https://github.com/myConsciousness/precondition-validator/releases)
- [Package](https://github.com/myConsciousness/precondition-validator/packages)
- [File a Bug](https://github.com/myConsciousness/precondition-validator/issues)
- [Reference](https://myconsciousness.github.io/precondition-validator/)