Package javax.validation
Interface ConstraintValidatorContext.ConstraintViolationBuilder
- Enclosing interface:
- ConstraintValidatorContext
public static interface ConstraintValidatorContext.ConstraintViolationBuilder
ConstraintViolation
builder allowing to optionally associate
the violation report to a sub path.
To create the ConstraintViolation
, one must call either one of
the addConstraintViolation()
methods available in one of the
interfaces of the fluent API.
If another method is called after addConstraintViolation()
on
ConstraintViolationBuilder
or any of its associated objects
an IllegalStateException
is raised.-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Represents a node whose context is configurable (i.e.static interface
Represents a node whose context is known (i.e.static interface
Represents refinement choices for a node which is in anIterator
orMap
.static interface
Represents a node whose context is configurable (i.e.static interface
Represents a node whose context is known (i.e.static interface
Represents refinement choices for a node which is in anIterator
orMap
. -
Method Summary
Modifier and TypeMethodDescriptionAdds a bean node (class-level) to the path theConstraintViolation
will be associated to.Adds the newConstraintViolation
to be generated if the constraint validator marks the value as invalid.Deprecated.addParameterNode
(int index) Adds a method parameter node to the path theConstraintViolation
will be associated to.addPropertyNode
(String name) Adds a property node to the path theConstraintViolation
will be associated to.
-
Method Details
-
addNode
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext addNode(String name) Deprecated.Adds a node to the path theConstraintViolation
will be associated to.name
describes 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 theConstraintViolation
will be associated to.name
describes 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 theConstraintViolation
will 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 theConstraintViolation
will 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 newConstraintViolation
to be generated if the constraint validator marks the value as invalid. Methods of thisConstraintViolationBuilder
instance and its nested objects throwIllegalStateException
from now on.- Returns:
- the
ConstraintValidatorContext
instance theConstraintViolationBuilder
comes from
-
addPropertyNode(String)
,addBeanNode()
andaddParameterNode(int)