javax.validation

インタフェース ConstraintValidatorContext.ConstraintViolationBuilder

含まれているインタフェース:

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.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext Represents a container element 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).
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderDefinedContext Represents a container element node whose context is known (i.e. index, key and isInIterable) and that is not necessarily a leaf node (i.e. subnodes can be added).
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeContextBuilder Represents refinement choices for a container element node.
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).
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderDefinedContext Represents a node whose context is known (i.e. index, key and isInIterable) and that is a leaf node (i.e. no subnode can be added).
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeContextBuilder Represents refinement choices for a node which is in an iterable, e.g. array, Iterable or Map.
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).
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext Represents a node whose context is known (i.e. index, key and isInIterable) and that is not necessarily a leaf node (i.e. subnodes can be added).
static interface	ConstraintValidatorContext.ConstraintViolationBuilder.NodeContextBuilder Represents refinement choices for a node which is in an iterable, e.g. array, Iterable or Map.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext	addBeanNode() Adds a bean node (class-level) to the path the ConstraintViolation will be associated to.
ConstraintValidatorContext	addConstraintViolation() Adds the new ConstraintViolation to be generated if the constraint validator marks the value as invalid.
ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext	addContainerElementNode(String name, Class<?> containerType, Integer typeArgumentIndex) Adds a container element node to the path the ConstraintViolation will be associated to.
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext	addNode(String name) 非推奨です。 since 1.1 - replaced by addPropertyNode(String), addBeanNode() and addParameterNode(int)
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext	addParameterNode(int index) Adds a method parameter node to the path the ConstraintViolation will be associated to.
ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext	addPropertyNode(String name) Adds a property node to the path the ConstraintViolation will be associated to.

メソッドの詳細

addNode

ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext addNode(String name)

非推奨です。 since 1.1 - replaced by addPropertyNode(String), addBeanNode() and addParameterNode(int)

Adds a node to the path the ConstraintViolation will be associated to.

name describes a single property. In particular, dot (.) is not allowed.

パラメータ:

name - property name

戻り値:

a builder representing node name

addPropertyNode

ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext addPropertyNode(String name)

Adds a property node to the path the ConstraintViolation will be associated to.

name describes a single property. In particular, dot (.) is not allowed.

パラメータ:

name - property name

戻り値:

a builder representing node name

例外:

IllegalArgumentException - if the name is null

導入されたバージョン:

1.1

addBeanNode

ConstraintValidatorContext.ConstraintViolationBuilder.LeafNodeBuilderCustomizableContext addBeanNode()

Adds a bean node (class-level) to the path the ConstraintViolation will be associated to. Note that bean nodes are always leaf nodes.

戻り値:

a builder representing the bean node

導入されたバージョン:

1.1

addContainerElementNode

ConstraintValidatorContext.ConstraintViolationBuilder.ContainerElementNodeBuilderCustomizableContext addContainerElementNode(String name,
                                                                                                                             Class<?> containerType,
                                                                                                                             Integer typeArgumentIndex)

Adds a container element node to the path the ConstraintViolation will be associated to.

パラメータ:

name - the node name

containerType - the type of the container

typeArgumentIndex - the index of the type argument

戻り値:

a builder representing the container element node

例外:

IllegalArgumentException - if the index is not valid

導入されたバージョン:

2.0

addParameterNode

ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderDefinedContext addParameterNode(int index)

Adds a method parameter node to the path the ConstraintViolation 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.

パラメータ:

index - the parameter index

戻り値:

a builder representing the index-th parameter node

例外:

IllegalArgumentException - if the index is not valid

導入されたバージョン:

1.1

addConstraintViolation

ConstraintValidatorContext addConstraintViolation()

Adds the new ConstraintViolation to be generated if the constraint validator marks the value as invalid.

Methods of this ConstraintViolationBuilder instance and its nested objects throw IllegalStateException from now on.

戻り値:

the ConstraintValidatorContext instance the ConstraintViolationBuilder comes from