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)

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ConstraintLocation.ConstraintLocationKind

Method Summary

Modifier and Type	Method and Description
public void	appendTo(ExecutableParameterNameProvider parameterNameProvider, PathImpl path) Appends a node representing this location to the given property path.
public static ConstraintLocation	forClass(Class<?> declaringClass)
public static ConstraintLocation	forCrossParameter(Callable callable)
public static ConstraintLocation	forField(Field field)
public static ConstraintLocation	forGetter(Getter getter)
public static ConstraintLocation	forParameter(Callable callable, int index)
public static ConstraintLocation	forReturnValue(Callable callable)
public static ConstraintLocation	forTypeArgument(ConstraintLocation delegate, TypeVariable<?> typeParameter, Type typeOfAnnotatedElement)
public Constrainable	Returns: the member represented by this location. Will be `null` when this location represents a type. getConstrainable() Returns the member represented by this location.
public Class<?>	getDeclaringClass() Returns the class hosting this location.
public ConstraintLocation.ConstraintLocationKind	getKind() Returns the nature of the constraint location.
public Type	Returns: The type to be used when resolving constraint validators for constraints at this location getTypeForValidatorResolution() Returns the type to be used when resolving constraint validators for constraints at this location.
public Object	getValue(Object parent) Obtains the value of this location from the parent.

Method Detail

appendTo	back to summary
public void appendTo(ExecutableParameterNameProvider parameterNameProvider, PathImpl path) Appends a node representing this location to the given property path.

forClass	back to summary
public static ConstraintLocation forClass(Class<?> declaringClass)

forCrossParameter	back to summary
public static ConstraintLocation forCrossParameter(Callable callable)

forField	back to summary
public static ConstraintLocation forField(Field field)

forGetter	back to summary
public static ConstraintLocation forGetter(Getter getter)

forParameter	back to summary
public static ConstraintLocation forParameter(Callable callable, int index)

forReturnValue	back to summary
public static ConstraintLocation forReturnValue(Callable callable)

forTypeArgument	back to summary
public static ConstraintLocation forTypeArgument(ConstraintLocation delegate, TypeVariable<?> typeParameter, Type typeOfAnnotatedElement)

getConstrainable back to summary

getConstrainable	back to summary
public Constrainable getConstrainable() Returns the member represented by this location. Returns:Constrainable the member represented by this location. Will be `null` when this location represents a type.

public Constrainable getConstrainable()

Returns the member represented by this location.

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

getDeclaringClass	back to summary
public Class<?> getDeclaringClass() Returns the class hosting this location.

getKind	back to summary
public ConstraintLocation.ConstraintLocationKind getKind() Returns the nature of the constraint location.

getTypeForValidatorResolution	back to summary
public 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:Type The type to be used when resolving constraint validators for constraints at this location

getTypeForValidatorResolution

back to summary

public 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:Type: The type to be used when resolving constraint validators for constraints at this location

getValue	back to summary
public 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 `AbstractPropertyConstraintLocation` but an object array for a `ParameterConstraintLocation`.

org.hibernate.validator.internal.metadata.location back to summary

public final Enum ConstraintLocation.ConstraintLocationKind

Class Inheritance

extends Enum<ConstraintLocation.ConstraintLocationKind>

java.lang.Object
java.lang.Enum
org.hibernate.validator.internal.metadata.location.ConstraintLocation.ConstraintLocationKind

Field Summary

Modifier and Type	Field and Description
public static final ConstraintLocation.ConstraintLocationKind	CONSTRUCTOR
private final ElementType	elementType
public static final ConstraintLocation.ConstraintLocationKind	FIELD
public static final ConstraintLocation.ConstraintLocationKind	GETTER
public static final ConstraintLocation.ConstraintLocationKind	METHOD
public static final ConstraintLocation.ConstraintLocationKind	PARAMETER
public static final ConstraintLocation.ConstraintLocationKind	TYPE
public static final ConstraintLocation.ConstraintLocationKind	TYPE_USE

Constructor Summary

Access	Constructor and Description
private	ConstraintLocationKind(ElementType elementType)

Method Summary

Modifier and Type	Method and Description
public ElementType	getElementType()
public boolean	isExecutable()
public boolean	isMethod()
public static ConstraintLocation.ConstraintLocationKind	of(ConstrainedElement.ConstrainedElementKind constrainedElementKind)
public static ConstraintLocation.ConstraintLocationKind	valueOf(String name)
public static ConstraintLocation.ConstraintLocationKind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONSTRUCTOR	back to summary
public static final ConstraintLocation.ConstraintLocationKind CONSTRUCTOR

elementType	back to summary
private final ElementType elementType

FIELD	back to summary
public static final ConstraintLocation.ConstraintLocationKind FIELD

GETTER	back to summary
public static final ConstraintLocation.ConstraintLocationKind GETTER

METHOD	back to summary
public static final ConstraintLocation.ConstraintLocationKind METHOD

PARAMETER	back to summary
public static final ConstraintLocation.ConstraintLocationKind PARAMETER

TYPE	back to summary
public static final ConstraintLocation.ConstraintLocationKind TYPE

TYPE_USE	back to summary
public static final ConstraintLocation.ConstraintLocationKind TYPE_USE

Constructor Detail

ConstraintLocationKind	back to summary
private ConstraintLocationKind(ElementType elementType)

Method Detail

getElementType	back to summary
public ElementType getElementType()

isExecutable	back to summary
public boolean isExecutable()

isMethod	back to summary
public boolean isMethod()

of	back to summary
public static ConstraintLocation.ConstraintLocationKind of(ConstrainedElement.ConstrainedElementKind constrainedElementKind)

valueOf	back to summary
public static ConstraintLocation.ConstraintLocationKind valueOf(String name)

values	back to summary
public static ConstraintLocation.ConstraintLocationKind[] values()

public Interface ConstraintLocation

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum ConstraintLocation.ConstraintLocationKind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail