Add TypedEqualsBuilder class and test #1114
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
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 { | ||
|
There was a problem hiding this comment. This is a confusing class name IMO. What is and where is the Type? It's not a Java There was a problem hiding this comment. It is the class type. its refering to the T class parameter which is supported by this Builder subtype. There was a problem hiding this comment. This equals builder is typed. We provide a type and then the field functions to build the equals method. There was a problem hiding this comment.
✅️ Thanks for pointing that out! 👍 |
||
|
|
||
| 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; | ||
| } | ||
| } | ||
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(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing punctuation, sentence fragment