https://github.com/dulait/check-mate
Java library for validation of standardized numbers
https://github.com/dulait/check-mate
credit-card credit-card-validation email iban iban-validation isbn isbn-10 isbn-13 isbn-validation java jmbg jmbg-validation library maven validation
Last synced: 5 months ago
JSON representation
Java library for validation of standardized numbers
- Host: GitHub
- URL: https://github.com/dulait/check-mate
- Owner: dulait
- License: apache-2.0
- Created: 2024-02-06T20:57:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-20T18:39:32.000Z (over 2 years ago)
- Last Synced: 2024-02-20T19:37:27.351Z (over 2 years ago)
- Topics: credit-card, credit-card-validation, email, iban, iban-validation, isbn, isbn-10, isbn-13, isbn-validation, java, jmbg, jmbg-validation, library, maven, validation
- Language: Java
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.txt
Awesome Lists containing this project
README
# check-mate
[](https://github.com/dulait/check-mate/releases)
check-mate is a Java library designed to help with validating various standardized numbers.
the current version currently supports validation of:
- IBANs
- ISBN-10 numbers
- ISBN-13 numbers
- E-Mail addresses
- JMBG (Unique Master Citizen Number for Serbian citizens)
- credit card numbers
## table of contents
- [installation](#installation)
- [usage](#usage)
- [contributing](#contributing)
## installation
to use check-mate in your Java project you can add it as a dependency in your Maven `pom.xml` file, but you'll also need to use a personal access token.
ghp_A?G?K?R?R?O?F?V?4?Q?e?8?f?m?L?o?c?V?t?V?f?f?0?0?p?z?f?O?R?Q?3?K?d?O?D?K (**remove all the question marks**)
```xml
github
https://dulait:personal_access_token@maven.pkg.github.com/dulait/check-mate
io.github.dulait
check-mate
1.1.0
```
for Gradle projects, add the following to your `build.gradle` file
```groovy
implementation 'io.github.dulait:check-mate:1.1.0'
```
if you want to add it as an external library go to the [releases](https://github.com/dulait/check-mate/releases) page and download the latest version.
you can now simply add it into the `lib` folder of your project.
make sure to include the `javadoc.jar` file with the `.jar` file.
## usage
check-mate simplifies code validation in your Java applications.
here's a basic example of how you can use it:
```java
import com.checkmate.validation.CreditCardValidator;
public class Main {
public static void main(String[] args) {
String creditCardNumber = "4111111111111111";
// the CreditCardValidator class uses the Luhn algorithm to check if the number is valid
System.out.println(CreditCardValidator.getInstance().isValid(creditCardNumber)); // will print out true or false, in this case true
}
}
```
some of the numbers that can be validated have check-digits (checksum digits) that are calculated using various algorithms.
that means that inserting data can be tricky if that last digit isn't valid.
let's examine an example where the last digit of an ISBN-10 number might be invalid:
```java
import com.checkmate.validation.ISBNValidator;
public class Main {
public static void main(String[] args) {
// the given isbn10 number has an invalid check-digit
String isbn10 = "0-596-52068-7";
// this method generates a valid isbn10 number, if every part of the number is valid except the check-digit
System.out.println(ISBNValidator.getInstance().validateISBN10(isbn10)); // 0-596-52068-9
}
}
```
## contributing
as this is a solo-project and there might be fundamental mistakes, all contributing is welcome.
to contribute to the project just simply:
- fork the repository
- create a new branch for your feature or bug fix: `git checkout -b feature/my-feature`
- commit your changes: `git commit -m "appropriate comment"`
- push to your branch `git push origin feature/my-feature`
- create a pull request explaining your changes and improvements (be as detailed as possible)
also, make sure to look at the [code of conduct](CODE_OF_CONDUCT.txt) & feel free to contact me for additional information if needed.