Overview

Utility library for verify if java objects fulfill the contracts of equals, hashcode and toString.

Please support this project by simply putting a Github Star ⭐

Share this library with friends on Twitter and everywhere else you can

If you love this project

gradle dependency

Replace the variable ${latestVersion} with the current latest version from the 'releases' directory.

add the new maven block of this repository to the repositories section from your build.gradle

repositories {
    // other maven blocks
    // maven block for this repository
    maven {
        name = "github jobj-contract-verifier releases"
        url "https://github.com/astrapi69/jobj-contract-verifier/raw/master/releases"
        mavenContent {
            releasesOnly()
        }
    }
}

You can first define the version in the ext section and add than the following gradle dependency to your project build.gradle if you want to import the core functionality of jobj-contract-verifier:

define version in file gradle.properties

jobjContractVerifierVersion=${latestVersion}

or in build.gradle ext area

    jobjContractVerifierVersion = "${latestVersion}"

then add the test dependency to the dependencies area

    testImplementation("io.github.astrapi69:jobj-contract-verifier:$jobjContractVerifierVersion")

with new libs.versions.toml file

If you use the new libs.versions.toml file for new automatic catalog versions update

[versions]
jobj-contract-verifier-version=${latestVersion}

[libraries]
jobj-contract-verifier = { module = "io.github.astrapi69:jobj-contract-verifier", version.ref = "jobj-contract-verifier-version" }

then add the test dependency to the dependencies area

    testImplementation libs.jobj.contract.verifier

Maven dependency

Maven dependency is now on sonatype. Check out sonatype repository for latest snapshots and releases.

Add the following maven dependency to your project pom.xml if you want to import the core functionality of jobj-contract-verifier:

Than you can add the dependency to your dependencies:

<properties>
        ...
    <!-- JOBJ-CONTRACT-VERIFIER version -->
    <jobj-contract-verifier.version>${latestVersion}</jobj-contract-verifier.version>
        ...
</properties>
        ...
    <dependencies>
        ...
        <!-- JOBJ-CONTRACT-VERIFIER DEPENDENCY -->
        <dependency>
            <groupId>io.github.astrapi69</groupId>
            <artifactId>jobj-contract-verifier</artifactId>
            <version>${jobj-contract-verifier.version}</version>
            <scope>test</scope>
        </dependency>
        ...
    </dependencies>

Donations

This project is kept as an open source product and relies on contributions to remain being developed. If you like this library, please consider a donation

over paypal:



or over bitcoin(BTC) with this address:

bc1ql2y99q7e8psndhcc3gferk03esw3qqf677rhjy

or over FIO with this address:

FIO7tFMUVAA9cHiPPqKMfMXiSxHrbpiFyRYqTketNuM67aULuwjop

or over Ethereum(ETH) with:

0xc057D159D3C8f3311E73568b334FF6fE82EB2b7D

or over Ethereum Classic(ETC) with:

0xF708cA86D86C246B69c3F4BAe431eBbe0c2bfddD

or over Dogecoin(DOGE) with:

D5yi4Um8cpakd6yPRm2hGWuQ5nrVzhSSW1

or over Monero(XMR) with:

49bqeRQ7Bf49oJFVC72pqpe5hFbb62pfXDYPdLsadGGF81KZW2ZfrPZ8PbAVu5X2v1TYAspeczMya3cYQysNS4usRRPQHVw

or over flattr:

Note

No animals were harmed in the making of this library.

License

The source code comes under the liberal MIT License, making jobj-contract-verifier great for all types of applications.

Semantic Versioning

The versions of jobj-contract-verifier are maintained with the Simplified Semantic Versioning guidelines.

Release version numbers will be incremented in the following format:

<major>.<minor>.<patch>

For detailed information on versioning for this project you can visit this wiki page.

Want to Help and improve it?

The source code for jobj-contract-verifier are on GitHub. Please feel free to fork and send pull requests!

Create your own fork of astrapi69/jobj-contract-verifier/fork

To share your changes, submit a pull request.

Don't forget to add new units tests on your changes.

Contacting the Developers

Do not hesitate to contact the jobj-contract-verifier developers with your questions, concerns, comments, bug reports, or feature requests.

• Feature requests, questions and bug reports can be reported at the issues page.

Similar projects

• equalsverifier EqualsVerifier can be used in Java unit tests to verify whether the contract for the equals and hashCode methods is met.

Credits

javadoc.io
Special thanks to javadoc.io for providing a free javadoc documentation for open source projects