jakarta.validation

Interface ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext

Enclosing interface:

ConstraintValidatorContext.ConstraintViolationBuilder

public static interface ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext

Represents a node whose context is configurable (i.e. index, key and isInIterable) and that is a leaf node (i.e. no subnode can be added).

Since:

1.1

Method Summary

Modifier and Type	Method and Description
ConstraintValidatorContext	addConstraintViolation() Adds the new ConstraintViolation to be generated if the constraint validator mark the value as invalid.
ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext	inContainer(Class<?> containerClass, Integer typeArgumentIndex) Marks the node as being in a container such as a List, Map or Optional.
ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeContextBuilder	inIterable() Marks the node as being in an iterable, e.g.

Method Detail

inIterable

ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeContextBuilder inIterable()

Marks the node as being in an iterable, e.g. array, Iterable or a Map.

Returns:

a builder representing iterable details

inContainer

ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext inContainer(Class<?> containerClass,
                                                                                                     Integer typeArgumentIndex)

Marks the node as being in a container such as a List, Map or Optional.

Parameters:

containerClass - the type of the container

typeArgumentIndex - 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

addConstraintViolation

ConstraintValidatorContext addConstraintViolation()

Adds the new ConstraintViolation 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 throw IllegalStateException after this call.

Returns:

ConstraintValidatorContext instance the ConstraintViolationBuilder comes from