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

Nested Classes

Modifier and Type	Interface and Description
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext Represent a node whose context is configurable (ie index, key and isInIterable)
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext Represent a node whose context is known (ie index, key and isInIterable)
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder Represent refinement choices for a node which is in an Iterator or Map.

Method Summary

Methods

Modifier and Type	Method and Description
ConstraintValidatorContext	addConstraintViolation() Add the new ConstraintViolation to be generated if the constraint validator marks the value as invalid.
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext	addNode(String name) Add a node to the path the ConstraintViolation will be associated to.

Method Detail

addNode

ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext addNode(String name)

Add a node to the path the ConstraintViolation 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

addConstraintViolation

ConstraintValidatorContext addConstraintViolation()

Add the new ConstraintViolation to be generated if the constraint validator marks the value as invalid. Methods of this ConstraintViolationBuilder instance and its nested objects return IllegalStateException from now on.

Returns:

the ConstraintValidatorContext instance the ConstraintViolationBuilder comes from