Package jakarta.validation.metadata
Interface ElementDescriptor.ConstraintFinder
-
- Enclosing interface:
- ElementDescriptor
public static interface ElementDescriptor.ConstraintFinder
Declares restrictions on retrieved constraints. Restrictions are cumulative.A
ConstraintFinder
is not thread-safe. The set of matchingConstraintDescriptor
is.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ElementDescriptor.ConstraintFinder
declaredOn(java.lang.annotation.ElementType... types)
Restricts to the constraints hosted on the listedtypes
for a given element.java.util.Set<ConstraintDescriptor<?>>
getConstraintDescriptors()
Retrieves the constraint descriptors following the defined restrictions and hosted on the element described byElementDescriptor
.boolean
hasConstraints()
Returnstrue
if at least one constraint declaration matching the restrictions is present on the element,false
otherwise.ElementDescriptor.ConstraintFinder
lookingAt(Scope scope)
Restricts to the constraints matching the provided scope for this element.ElementDescriptor.ConstraintFinder
unorderedAndMatchingGroups(java.lang.Class<?>... groups)
Restricts to the constraints matching a given set of groups for this element.
-
-
-
Method Detail
-
unorderedAndMatchingGroups
ElementDescriptor.ConstraintFinder unorderedAndMatchingGroups(java.lang.Class<?>... groups)
Restricts to the constraints matching a given set of groups for this element.This method respects group conversion, group sequences and group inheritance (including class-level
Default
group overriding) but does not returnConstraintDescriptor
s in any particular order. Specifically, ordering of the group sequence is not respected.- Parameters:
groups
- groups targeted- Returns:
this
following the chaining method pattern
-
lookingAt
ElementDescriptor.ConstraintFinder lookingAt(Scope scope)
Restricts to the constraints matching the provided scope for this element. Defaults toScope.HIERARCHY
- Parameters:
scope
- expected scope- Returns:
this
following the chaining method pattern
-
declaredOn
ElementDescriptor.ConstraintFinder declaredOn(java.lang.annotation.ElementType... types)
Restricts to the constraints hosted on the listedtypes
for a given element.Defaults to all possible types of the element.
Typically used to restrict to fields (
FIELD
) or getters (METHOD
).- Parameters:
types
- targeted types- Returns:
this
following the chaining method pattern
-
getConstraintDescriptors
java.util.Set<ConstraintDescriptor<?>> getConstraintDescriptors()
Retrieves the constraint descriptors following the defined restrictions and hosted on the element described byElementDescriptor
.- Returns:
- matching constraint descriptors
-
hasConstraints
boolean hasConstraints()
Returnstrue
if at least one constraint declaration matching the restrictions is present on the element,false
otherwise.- Returns:
true
if there is at least one constraint
-
-