Skip to content

Commit

Permalink
Eliminate jstructural
Browse files Browse the repository at this point in the history
  • Loading branch information
io7m committed May 4, 2024
1 parent f1c22e5 commit 0f9a4ee
Show file tree
Hide file tree
Showing 12 changed files with 74 additions and 771 deletions.
33 changes: 33 additions & 0 deletions README.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

## jequality

The `jequality` package provides functions to compare floating-point numbers,
annotations to mark classes as using specific types of equality, and a validator
for equality methods.

## Status

As the Java platform evolves, libraries that may have been necessary in the
past can become unnecessary due to new platform features. If you were already
using `jequality`, then you know what it does and why you were using it. If
you aren't already using `jequality`, then you should not start.

This package is in maintenance mode and will not see any new functionality.

Use [equalsverifier](https://jqno.nl/equalsverifier/) as a replacement for
the `jequality` validator.

Use JDK 17 record types to eliminate a lot of the issues with `equals()` and
`hashCode()`.

Use JUnit 5 assertions to perform approximate equality checks of floating-point
values in unit tests. Outside of unit tests, find some other way to compare
numbers.

## Features

* High coverage test suite.
* Written in pure Java 21.
* [OSGi-ready](https://www.osgi.org/)
* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
* ISC license.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,37 @@ jequality
| OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/jequality/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/jequality/actions?query=workflow%3Amain.linux.temurin.lts)|
| OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jequality/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/jequality/actions?query=workflow%3Amain.windows.temurin.current)|
| OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jequality/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/jequality/actions?query=workflow%3Amain.windows.temurin.lts)|

## jequality

The `jequality` package provides functions to compare floating-point numbers,
annotations to mark classes as using specific types of equality, and a validator
for equality methods.

## Status

As the Java platform evolves, libraries that may have been necessary in the
past can become unnecessary due to new platform features. If you were already
using `jequality`, then you know what it does and why you were using it. If
you aren't already using `jequality`, then you should not start.

This package is in maintenance mode and will not see any new functionality.

Use [equalsverifier](https://jqno.nl/equalsverifier/) as a replacement for
the `jequality` validator.

Use JDK 17 record types to eliminate a lot of the issues with `equals()` and
`hashCode()`.

Use JUnit 5 assertions to perform approximate equality checks of floating-point
values in unit tests. Outside of unit tests, find some other way to compare
numbers.

## Features

* High coverage test suite.
* Written in pure Java 21.
* [OSGi-ready](https://www.osgi.org/)
* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System)
* ISC license.

214 changes: 0 additions & 214 deletions com.io7m.jequality.documentation/pom.xml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 0f9a4ee

Please sign in to comment.