Package jakarta.validation
Interface ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext
-
- Enclosing interface:
- ConstraintValidatorContext.ConstraintViolationBuilder
public static interface ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext
Represents a node whose context is configurable (i.e. index, key and isInIterable) and that is not necessarily a leaf node (i.e. subnodes can be added).
-
-
Method Summary
-
-
-
Method Detail
-
inIterable
ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder inIterable()
Marks the node as being in an iterable, e.g. array,Iterable
or aMap
.- Returns:
- a builder representing iterable details
-
inContainer
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext inContainer(Class<?> containerClass, Integer typeArgumentIndex)
Marks the node as being in a container such as aList
,Map
orOptional
.- Parameters:
containerClass
- the type of the containertypeArgumentIndex
- type index of the concerned type argument- Returns:
- a builder representing the current node
- Throws:
IllegalArgumentException
- if the index is not valid- Since:
- 2.0
-
addNode
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext addNode(String name)
Deprecated.since 1.1 - replaced byaddPropertyNode(String)
andaddBeanNode()
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
-
addContainerElementNode
ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext addContainerElementNode(String name, Class<?> containerType, Integer typeArgumentIndex)
Adds a container element node to the path theConstraintViolation
will be associated to.- Parameters:
name
- the node namecontainerType
- the type of the containertypeArgumentIndex
- the index of the type argument- Returns:
- a builder representing the container element node
- Throws:
IllegalArgumentException
- if the index is not valid- Since:
- 2.0
-
addConstraintViolation
ConstraintValidatorContext addConstraintViolation()
Adds the newConstraintViolation
to be generated if the constraint validator mark the value as invalid.Methods of the
ConstraintViolationBuilder
instance this object comes from and the constraint violation builder nested objects throwIllegalStateException
after this call.- Returns:
ConstraintValidatorContext
instance theConstraintViolationBuilder
comes from
-
-