Add customizeProperty API as maintained (#1044)

naver · Sep 28, 2024 · f508987 · f508987
1 parent 92ba51c
commit f508987
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/fixture-monkey/src/main/java/com/navercorp/fixturemonkey/ArbitraryBuilder.java b/fixture-monkey/src/main/java/com/navercorp/fixturemonkey/ArbitraryBuilder.java
@@ -557,6 +557,18 @@ <R> ArbitraryBuilder<R> zipWith(
 
 	ArbitraryBuilder<T> instantiate(TypeReference<?> type, Instantiator instantiator);
 
+	/**
+	 * Customizes the arbitrary value generated from selected properties.
+	 * It can be called several times and nested. It has an order dependency.
+	 * <p>
+	 * Without any set APIs, it customizes the arbitrary value.
+	 * With set APIs, it customizes the last value in set APIs.
+	 *
+	 * @param propertySelector              the property selector with type
+	 * @param combinableArbitraryCustomizer
+	 * @param <U>                           the type of the properties selected by {@code propertySelector}.
+	 * @return a customized {@link ArbitraryBuilder}
+	 */
 	@API(since = "1.0.9", status = Status.MAINTAINED)
 	<U> ArbitraryBuilder<T> customizeProperty(
 		TypedPropertySelector<U> propertySelector,