-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
https://issues.apache.org/jira/browse/LANG-1712
Add TypedEqualsBuilder class and test
- Loading branch information
Marc Cappelletti
committed
Sep 27, 2023
1 parent
14be5e5
commit 602c964
Showing
3 changed files
with
210 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
src/main/java/org/apache/commons/lang3/builder/TypedEqualsBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
| package org.apache.commons.lang3.builder; | ||
|
|
||
| import org.apache.commons.lang3.function.FailableFunction; | ||
|
|
||
| import java.util.Objects; | ||
| import java.util.function.Function; | ||
|
|
||
| /** | ||
| * An extension of {@link EqualsBuilder} that is typed and meant to append field getter functions. | ||
| * it does the nullity and class equality checks before checking the appended values. | ||
| * | ||
| * <p>Typical use for the code is as follows:</p> | ||
| * <pre> | ||
| * public boolean equals(Object obj) { | ||
| * return new TypedEqualsBuilder<>(this) | ||
| * .appendBaseObject(obj) | ||
| * .append(TestObject::getA) | ||
| * .append(TestObject::getB) | ||
| * .isEquals(); | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @param <T> the type of the compared object. | ||
| * | ||
| * @since 3.14.0 | ||
| */ | ||
| public class TypedEqualsBuilder<T> extends EqualsBuilder { | ||
|
|
||
| private final T currentInstance; | ||
|
|
||
| private boolean sameReference = false; | ||
| private T other; | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| public TypedEqualsBuilder(T currentInstance, Object other) { | ||
| Objects.requireNonNull(currentInstance); | ||
| this.currentInstance = currentInstance; | ||
| if (currentInstance == other) { | ||
| sameReference = true; | ||
| return; | ||
| } | ||
| Class<T> currentInstanceClass = (Class<T>) currentInstance.getClass(); | ||
| if (other == null || currentInstanceClass != other.getClass()) { | ||
| isEquals = false; | ||
| return; | ||
| } | ||
| this.other = (T) other; | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean interruptEqualityCheck() { | ||
| return sameReference || super.interruptEqualityCheck(); | ||
| } | ||
|
|
||
| public TypedEqualsBuilder<T> append(FailableFunction<T, ?, Exception> extractor) { | ||
| if (interruptEqualityCheck()) { | ||
| return this; | ||
| } | ||
| try { | ||
| super.append(extractor.apply(currentInstance), extractor.apply(other)); | ||
| } catch (Exception e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| return this; | ||
| } | ||
| } |
97 changes: 97 additions & 0 deletions
97
src/test/java/org/apache/commons/lang3/builder/TypedEqualsBuilderTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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. | ||
| */ | ||
| package org.apache.commons.lang3.builder; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.*; | ||
|
|
||
| class TypedEqualsBuilderTest { | ||
|
|
||
| @Test | ||
| void test_complete_equals() { | ||
| TestObject testObject1 = new TestObject(1, 2); | ||
| TestObject testObject2 = new TestObject(1, 3); | ||
| TestObject testObject3 = new TestObject(1, 2); | ||
|
|
||
| assertEquals(testObject1, testObject1); | ||
| assertNotEquals(testObject1, testObject2); | ||
| assertNotEquals(testObject2, testObject1); | ||
|
|
||
| assertTrue( | ||
| new TypedEqualsBuilder<>(testObject1, testObject2) | ||
| .append(TestObject::getA) | ||
| .isEquals()); | ||
| assertTrue( | ||
| new TypedEqualsBuilder<>(testObject1, testObject3) | ||
| .append(TestObject::getA) | ||
| .append(TestObject::getB) | ||
| .isEquals()); | ||
| assertFalse( | ||
| new TypedEqualsBuilder<>(testObject1, testObject2) | ||
| .append(TestObject::getA) | ||
| .append(TestObject::getB) | ||
| .isEquals()); | ||
| assertFalse( | ||
| new TypedEqualsBuilder<>(testObject2, testObject1) | ||
| .append(TestObject::getA) | ||
| .append(TestObject::getB) | ||
| .isEquals()); | ||
| assertFalse( | ||
| new TypedEqualsBuilder<>(testObject1, null) | ||
| .append(TestObject::getA) | ||
| .isEquals()); | ||
| assertFalse( | ||
| new TypedEqualsBuilder<>(testObject1, "") | ||
| .append(TestObject::getA) | ||
| .isEquals()); | ||
| assertThrows(RuntimeException.class, | ||
| () -> new TypedEqualsBuilder<>(testObject1, testObject2) | ||
| .append(TestObject::getSomethingWithException) | ||
| .isEquals()); | ||
| } | ||
|
|
||
| private static class TestObject { | ||
| int a; | ||
| int b; | ||
|
|
||
| public TestObject(int a, int b) { | ||
| this.a = a; | ||
| this.b = b; | ||
| } | ||
|
|
||
| public int getA() { | ||
| return a; | ||
| } | ||
|
|
||
| public int getB() { | ||
| return b; | ||
| } | ||
|
|
||
| public int getSomethingWithException() throws Exception { | ||
| throw new Exception("something went wrong"); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object obj) { | ||
| return new TypedEqualsBuilder<>(this, obj) | ||
| .append(TestObject::getA) | ||
| .append(TestObject::getB) | ||
| .isEquals(); | ||
| } | ||
| } | ||
| } |