Retrofit ExampleMatcher with TypedPropertyPath.

Author: mp911de

src/main/java/org/springframework/data/domain/ExampleMatcher.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.domain;
 
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -24,6 +25,7 @@
 
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.data.util.TypedPropertyPath;
 import org.springframework.lang.CheckReturnValue;
 import org.springframework.lang.Contract;
 import org.springframework.util.Assert;
@@ -77,6 +79,21 @@ static ExampleMatcher matchingAll() {
 		return new TypedExampleMatcher().withMode(MatchMode.ALL);
 	}
 
+	/**
+	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code propertyPaths}. This instance is immutable
+	 * and unaffected by this method call.
+	 *
+	 * @param ignoredPaths must not be {@literal null} and not empty.
+	 * @return new instance of {@link ExampleMatcher}.
+	 * @since 4.1
+	 */
+	@Contract("_ -> new")
+	@CheckReturnValue
+	default <T> ExampleMatcher withIgnorePaths(TypedPropertyPath<T, ?>... ignoredPaths) {
+		return withIgnorePaths(Arrays.stream(ignoredPaths).map(TypedPropertyPath::of).map(TypedPropertyPath::toDotPath)
+				.toArray(String[]::new));
+	}
+
 	/**
 	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code propertyPaths}. This instance is immutable
 	 * and unaffected by this method call.
@@ -122,6 +139,22 @@ default ExampleMatcher withIgnoreCase() {
 	@CheckReturnValue
 	ExampleMatcher withIgnoreCase(boolean defaultIgnoreCase);
 
+	/**
+	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code GenericPropertyMatcher} for the
+	 * {@code propertyPath}. This instance is immutable and unaffected by this method call.
+	 *
+	 * @param propertyPath must not be {@literal null}.
+	 * @param matcherConfigurer callback to configure a {@link GenericPropertyMatcher}, must not be {@literal null}.
+	 * @return new instance of {@link ExampleMatcher}.
+	 * @since 4.1
+	 */
+	@Contract("_, _ -> new")
+	@CheckReturnValue
+	default <T, P> ExampleMatcher withMatcher(TypedPropertyPath<T, P> propertyPath,
+			MatcherConfigurer<GenericPropertyMatcher> matcherConfigurer) {
+		return withMatcher(propertyPath.toDotPath(), matcherConfigurer);
+	}
+
 	/**
 	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code GenericPropertyMatcher} for the
 	 * {@code propertyPath}. This instance is immutable and unaffected by this method call.
@@ -143,6 +176,21 @@ default ExampleMatcher withMatcher(String propertyPath, MatcherConfigurer<Generi
 		return withMatcher(propertyPath, genericPropertyMatcher);
 	}
 
+	/**
+	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code GenericPropertyMatcher} for the
+	 * {@code propertyPath}. This instance is immutable and unaffected by this method call.
+	 *
+	 * @param propertyPath must not be {@literal null}.
+	 * @param genericPropertyMatcher callback to configure a {@link GenericPropertyMatcher}, must not be {@literal null}.
+	 * @return new instance of {@link ExampleMatcher}.
+	 */
+	@Contract("_, _ -> new")
+	@CheckReturnValue
+	default <T, P> ExampleMatcher withMatcher(TypedPropertyPath<T, P> propertyPath,
+			GenericPropertyMatcher genericPropertyMatcher) {
+		return withMatcher(propertyPath.toDotPath(), genericPropertyMatcher);
+	}
+
 	/**
 	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code GenericPropertyMatcher} for the
 	 * {@code propertyPath}. This instance is immutable and unaffected by this method call.
@@ -155,6 +203,22 @@ default ExampleMatcher withMatcher(String propertyPath, MatcherConfigurer<Generi
 	@CheckReturnValue
 	ExampleMatcher withMatcher(String propertyPath, GenericPropertyMatcher genericPropertyMatcher);
 
+	/**
+	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code PropertyValueTransformer} for the
+	 * {@code propertyPath}.
+	 *
+	 * @param propertyPath must not be {@literal null}.
+	 * @param propertyValueTransformer must not be {@literal null}.
+	 * @return new instance of {@link ExampleMatcher}.
+	 * @since 4.1
+	 */
+	@Contract("_, _ -> new")
+	@CheckReturnValue
+	default <T, P> ExampleMatcher withTransformer(TypedPropertyPath<T, P> propertyPath,
+			PropertyValueTransformer propertyValueTransformer) {
+		return withTransformer(propertyPath.toDotPath(), propertyValueTransformer);
+	}
+
 	/**
 	 * Returns a copy of this {@link ExampleMatcher} with the specified {@code PropertyValueTransformer} for the
 	 * {@code propertyPath}.
@@ -167,6 +231,20 @@ default ExampleMatcher withMatcher(String propertyPath, MatcherConfigurer<Generi
 	@CheckReturnValue
 	ExampleMatcher withTransformer(String propertyPath, PropertyValueTransformer propertyValueTransformer);
 
+	/**
+	 * Returns a copy of this {@link ExampleMatcher} with ignore case sensitivity for the {@code propertyPaths}. This
+	 * instance is immutable and unaffected by this method call.
+	 *
+	 * @param propertyPaths must not be {@literal null} and not empty.
+	 * @return new instance of {@link ExampleMatcher}.
+	 */
+	@Contract("_ -> new")
+	@CheckReturnValue
+	default <T> ExampleMatcher withIgnoreCase(TypedPropertyPath<T, ?>... propertyPaths) {
+		return withIgnoreCase(Arrays.stream(propertyPaths).map(TypedPropertyPath::of).map(TypedPropertyPath::toDotPath)
+				.toArray(String[]::new));
+	}
+
 	/**
 	 * Returns a copy of this {@link ExampleMatcher} with ignore case sensitivity for the {@code propertyPaths}. This
 	 * instance is immutable and unaffected by this method call.

src/test/java/org/springframework/data/domain/ExampleMatcherUnitTests.java

@@ -121,6 +121,15 @@ void ignoredPathsShouldReturnUniqueProperties() {
 		assertThat(matcher.getIgnoredPaths()).hasSize(2);
 	}
 
+	@Test //
+	void ignoredPropertyPathsShouldReturnUniqueProperties() {
+
+		matcher = matching().withIgnorePaths(Person::getFirstname, Person::getLastname, Person::getFirstname);
+
+		assertThat(matcher.getIgnoredPaths()).contains("firstname", "lastname");
+		assertThat(matcher.getIgnoredPaths()).hasSize(2);
+	}
+
 	@Test // DATACMNS-810
 	void withCreatesNewInstance() {
 
@@ -160,11 +169,11 @@ void anyMatcherYieldsAnyMatching() {
 	void shouldCompareUsingHashCodeAndEquals() {
 
 		matcher = matching() //
-				.withIgnorePaths("foo", "bar", "baz") //
+				.withIgnorePaths(Random::getFoo, Random::getBar, Random::getBaz) //
 				.withNullHandler(NullHandler.IGNORE) //
 				.withIgnoreCase("ignored-case") //
-				.withMatcher("hello", GenericPropertyMatchers.contains().caseSensitive()) //
-				.withMatcher("world", GenericPropertyMatcher::endsWith);
+				.withMatcher(Random::getHello, GenericPropertyMatchers.contains().caseSensitive()) //
+				.withMatcher(Random::getWorld, GenericPropertyMatcher::endsWith);
 
 		var sameAsMatcher = matching() //
 				.withIgnorePaths("foo", "bar", "baz") //
@@ -182,8 +191,54 @@ void shouldCompareUsingHashCodeAndEquals() {
 		assertThat(matcher).isEqualTo(sameAsMatcher).isNotEqualTo(different);
 	}
 
+	static class Random {
+
+		String foo;
+		String bar;
+		String baz;
+		String hello;
+		String world;
+
+		public String getFoo() {
+			return foo;
+		}
+
+		public String getBar() {
+			return bar;
+		}
+
+		public String getBaz() {
+			return baz;
+		}
+
+		public String getHello() {
+			return hello;
+		}
+
+		public String getWorld() {
+			return world;
+		}
+	}
+
 	static class Person {
 
 		String firstname;
+		String lastname;
+
+		public String getFirstname() {
+			return firstname;
+		}
+
+		public void setFirstname(String firstname) {
+			this.firstname = firstname;
+		}
+
+		public String getLastname() {
+			return lastname;
+		}
+
+		public void setLastname(String lastname) {
+			this.lastname = lastname;
+		}
 	}
 }