https://github.com/willhains/equality
Elegant API for implementing equals(), hashCode(), and toString() in Java classes.
https://github.com/willhains/equality
Last synced: 3 months ago
JSON representation
Elegant API for implementing equals(), hashCode(), and toString() in Java classes.
- Host: GitHub
- URL: https://github.com/willhains/equality
- Owner: willhains
- License: mit
- Created: 2013-01-05T17:02:41.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-02-14T20:19:23.000Z (over 4 years ago)
- Last Synced: 2023-04-05T13:15:41.250Z (about 2 years ago)
- Language: Java
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Equality [](https://travis-ci.org/willhains/equality)
An elegant API for implementing Java's `equals()`, `hashCode()`, and `toString()` methods.
## How to use Equality
Just declare a private static constant `Equality`, with a list of accessors for
the properties you want to participate in `equals()` and `hashCode()`.
```java
public class MyClass
{
private String name;
private int productCode;
private Color color;
private static final Equality EQ = Equality.ofProperties(
$ -> $.name,
$ -> $.productCode,
$ -> $.color);
@Override public boolean equals(Object o) { return EQ.compare(this, o); }
@Override public int hashCode() { return EQ.hash(this); }
@Override public String toString() { return EQ.format(this); }
}
```
There is also an even shorter way to create the `Equality` constant, if you don't mind reflection:
```java
private static final Equality EQ = Equality.reflect(MyClass.class);
```
## Why another `equals()` and `hashCode()` utility?
Because it's better.
With Equality, you write less code, it's more readable, and more maintainable.
And there's nothing to memorise: if your IDE supports code completion (and, even
better, dynamic display of Javadoc), you will be prompted what to do as you
write the code.
## Development Status
Equality is production-ready, and is already used in mission-critical systems
of a large financial institution. (No guarantees of safety or quality are made
or implied. Use at your own risk.) Comments and contributions are welcome
and encouraged. Public APIs are unlikely to change, but may do so without
notice.
## Contribution
1. Fork
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request