-
- Enclosing interface:
- ConstraintValidatorContext
public static interface ConstraintValidatorContext.ConstraintViolationBuilderConstraintViolationbuilder allowing to optionally associate the violation report to a sub path. To create theConstraintViolation, one must call either one of theaddConstraintViolation()methods available in one of the interfaces of the fluent API. If another method is called afteraddConstraintViolation()onConstraintViolationBuilderor any of its associated objects anIllegalStateExceptionis raised.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interfaceConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContextRepresents a node whose context is configurable (i.e.static interfaceConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderDefinedContextRepresents a node whose context is known (i.e.static interfaceConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeContextBuilderRepresents refinement choices for a node which is in anIteratororMap.static interfaceConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContextRepresents a node whose context is configurable (i.e.static interfaceConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContextRepresents a node whose context is known (i.e.static interfaceConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilderRepresents refinement choices for a node which is in anIteratororMap.
-
Method Summary
-
-
-
Method Detail
-
addNode
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext addNode(String name)
Deprecated. since 1.1 - replaced byaddPropertyNode(String),addBeanNode()andaddParameterNode(int)Adds a node to the path theConstraintViolationwill be associated to.namedescribes a single property. In particular, dot (.) is not allowed.- Parameters:
name- property name- Returns:
- a builder representing node
name
-
addPropertyNode
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext addPropertyNode(String name)
Adds a property node to the path theConstraintViolationwill be associated to.namedescribes a single property. In particular, dot (.) is not allowed.- Parameters:
name- property name- Returns:
- a builder representing node
name - Throws:
IllegalArgumentException- if the name is null- Since:
- 1.1
-
addBeanNode
ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext addBeanNode()
Adds a bean node (class-level) to the path theConstraintViolationwill be associated to. Note that bean nodes are always leaf nodes.- Returns:
- a builder representing the bean node
- Since:
- 1.1
-
addParameterNode
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext addParameterNode(int index)
Adds a method parameter node to the path theConstraintViolationwill be associated to. The parameter index must be valid (i.e. within the boundaries of the method parameter indexes). May only be called from within cross-parameter validators.- Parameters:
index- the parameter index- Returns:
- a builder representing the index-th parameter node
- Throws:
IllegalArgumentException- if the index is not valid- Since:
- 1.1
-
addConstraintViolation
ConstraintValidatorContext addConstraintViolation()
Adds the newConstraintViolationto be generated if the constraint validator marks the value as invalid. Methods of thisConstraintViolationBuilderinstance and its nested objects throwIllegalStateExceptionfrom now on.- Returns:
- the
ConstraintValidatorContextinstance theConstraintViolationBuildercomes from
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/validation/ConstraintValidatorContext.ConstraintViolationBuilder.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.