Skip to content

Commit 8c0cbe6

Browse files
committed
HV-1831 Add missing javadocs to the new voter interfaces
1 parent 26f91da commit 8c0cbe6

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

engine/src/main/java/org/hibernate/validator/BaseHibernateValidatorConfiguration.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -488,6 +488,14 @@ default S locales(Locale... locales) {
488488
@Incubating
489489
S failFastOnPropertyViolation(boolean failFastOnPropertyViolation);
490490

491+
/**
492+
* Allows providing a custom bean tracking voter that helps to identify whether
493+
* the processed beans have to be tracked when cascaded into.
494+
*
495+
* @param processedBeanTrackingVoter the {@link ProcessedBeansTrackingVoter bean tracking voter} to apply.
496+
* @return {@code this} following the chaining method pattern
497+
* @since 9.1
498+
*/
491499
@Incubating
492500
S processedBeansTrackingVoter(ProcessedBeansTrackingVoter processedBeanTrackingVoter);
493501
}

engine/src/main/java/org/hibernate/validator/spi/tracking/ProcessedBeansTrackingVoter.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88

99
import org.hibernate.validator.Incubating;
1010

11+
/**
12+
* Helps to determine whether the processed beans of a particular type have to be tracked
13+
* when cascaded into. Used during metadata building step.
14+
* <p>
15+
* The default voter returns {@link Vote#DEFAULT} which means that if the bean has any cascading properties,
16+
* it will be considered as such that requires tracking,
17+
* and if there are no cascading properties -- the bean tracking is ignored for this type.
18+
*/
1119
@Incubating
1220
public interface ProcessedBeansTrackingVoter {
1321

0 commit comments

Comments
 (0)