org.hibernate.validator.internal.metadata.location

Interface ConstraintLocation

All Known Implementing Classes:

FieldConstraintLocation, GetterConstraintLocation, ParameterConstraintLocation, TypeArgumentConstraintLocation

public interface ConstraintLocation

Represents the location (e.g. a bean, field or method parameter) of a constraint and provides logic related to it, e.g. for appending the location to a given property path.

Note that while the validation engine works on the aggregated meta-model (which e.g. provides a unified view for properties, be them represented via fields or getter methods) most of the time, in some situations the physical element which hosts a constraint is relevant. This includes

• retrieval of property values to be validated (either field or getter access)
• constraint validator resolution; a field and the corresponding getter method may have different types, causing potentially different validators to kick in for the constraints declared on either element
• determination of a constraint's scope (locally defined or up in the hierarchy)

Author:

Hardy Ferentschik, Gunnar Morling

Method Summary

Modifier and Type	Method and Description
void	appendTo(ExecutableParameterNameProvider parameterNameProvider, PathImpl path) Appends a node representing this location to the given property path.
static ConstraintLocation	forClass(Class<?> declaringClass)
static ConstraintLocation	forCrossParameter(Executable executable)
static ConstraintLocation	forField(Field field)
static ConstraintLocation	forGetter(Class<?> declaringClass, Method getter) Create a new GetterConstraintLocation for the given declaring class and getter method.
static ConstraintLocation	forGetter(Method getter) Create a new GetterConstraintLocation for the given getter method.
static ConstraintLocation	forParameter(Executable executable, int index)
static ConstraintLocation	forReturnValue(Executable executable)
static ConstraintLocation	forTypeArgument(ConstraintLocation delegate, TypeVariable<?> typeParameter, Type typeOfAnnotatedElement)
Class<?>	getDeclaringClass() Returns the class hosting this location.
Member	getMember() Returns the member represented by this location.
Type	getTypeForValidatorResolution() Returns the type to be used when resolving constraint validators for constraints at this location.
Object	getValue(Object parent) Obtains the value of this location from the parent.

Method Detail

forClass

static ConstraintLocation forClass(Class<?> declaringClass)

forField

static ConstraintLocation forField(Field field)

forGetter

static ConstraintLocation forGetter(Method getter)

Create a new GetterConstraintLocation for the given getter method.

Parameters:

getter - The getter method being constrained

Returns:

A new GetterConstraintLocation

forGetter

static ConstraintLocation forGetter(Class<?> declaringClass,
                                    Method getter)

Create a new GetterConstraintLocation for the given declaring class and getter method.

This provides an alternative to forGetter(Method) where the given declaring class is usually a sub-class of the actual class on which the getter method is declared. This is provided to support XML mapping configurations used to specify constraints on subclasses for inherited getter methods.

Parameters:

declaringClass - The class on which the constraint is defined.

getter - The getter method being constrained.

Returns:

A new GetterConstraintLocation

forTypeArgument

static ConstraintLocation forTypeArgument(ConstraintLocation delegate,
                                          TypeVariable<?> typeParameter,
                                          Type typeOfAnnotatedElement)

forReturnValue

static ConstraintLocation forReturnValue(Executable executable)

forCrossParameter

static ConstraintLocation forCrossParameter(Executable executable)

forParameter

static ConstraintLocation forParameter(Executable executable,
                                       int index)

getDeclaringClass

Class<?> getDeclaringClass()

Returns the class hosting this location.

getMember

Member getMember()

Returns the member represented by this location.

Returns:

the member represented by this location. Will be null when this location represents a type.

getTypeForValidatorResolution

Type getTypeForValidatorResolution()

Returns the type to be used when resolving constraint validators for constraints at this location. Note that this is not always the same type as the type of the element described by this location; E.g. the wrapper type will is used for constraint validator resolution, if a constraint is declared in an element with a primitive type.

Returns:

The type to be used when resolving constraint validators for constraints at this location

appendTo

void appendTo(ExecutableParameterNameProvider parameterNameProvider,
              PathImpl path)

Appends a node representing this location to the given property path.

getValue

Object getValue(Object parent)

Obtains the value of this location from the parent. The type of the passed parent depends on the location type, e.g. a bean would be passed for a FieldConstraintLocation or GetterConstraintLocation but an object array for a ParameterConstraintLocation.