-
public interface ConstraintViolation<T>
Describes a constraint violation. This object exposes the constraint violation context as well as the message describing the violation.- Author:
- Emmanuel Bernard
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ConstraintDescriptor<?>
getConstraintDescriptor()
Returns the constraint metadata reported to fail.Object[]
getExecutableParameters()
Returns anObject[]
representing the constructor or method invocation arguments if theConstraintViolation
is returned after validating the method or constructor parameters.Object
getExecutableReturnValue()
Returns the return value of the constructor or method invocation if theConstraintViolation
is returned after validating the method or constructor return value.Object
getInvalidValue()
Returns the value failing to pass the constraint.Object
getLeafBean()
Returns: the bean instance the constraint is applied on if it is a bean constraint the bean instance hosting the property the constraint is applied on if it is a property constraintnull
when theConstraintViolation
is returned after callingValidator.validateValue(Class, String, Object, Class[])
the object the method is executed on if it is a method parameter, cross-parameter or return value constraintnull
if it is a constructor parameter or cross-parameter constraint the object the constructor has created if it is a constructor return value constraintString
getMessage()
String
getMessageTemplate()
Path
getPropertyPath()
T
getRootBean()
Returns the root bean being validated.Class<T>
getRootBeanClass()
Returns the class of the root bean being validated.<U> U
unwrap(Class<U> type)
Returns an instance of the specified type allowing access to provider-specific APIs.
-
-
-
Method Detail
-
getMessage
String getMessage()
- Returns:
- the interpolated error message for this constraint violation
-
getMessageTemplate
String getMessageTemplate()
- Returns:
- the non-interpolated error message for this constraint violation
-
getRootBean
T getRootBean()
Returns the root bean being validated. For method validation, returns the object the method is executed on. Returnsnull
when:- the
ConstraintViolation
is returned after callingValidator.validateValue(Class, String, Object, Class[])
- the
ConstraintViolation
is returned after validating a constructor.
- Returns:
- the validated object, the object hosting the validated element or
null
- the
-
getRootBeanClass
Class<T> getRootBeanClass()
Returns the class of the root bean being validated. For method validation, this is the object class the method is executed on. For constructor validation, this is the class the constructor is declared on.- Returns:
- the class of the root bean or of the object hosting the validated element
-
getLeafBean
Object getLeafBean()
Returns:- the bean instance the constraint is applied on if it is a bean constraint
- the bean instance hosting the property the constraint is applied on if it is a property constraint
null
when theConstraintViolation
is returned after callingValidator.validateValue(Class, String, Object, Class[])
- the object the method is executed on if it is a method parameter, cross-parameter or return value constraint
null
if it is a constructor parameter or cross-parameter constraint- the object the constructor has created if it is a constructor return value constraint
- Returns:
- the leaf bean
-
getExecutableParameters
Object[] getExecutableParameters()
Returns anObject[]
representing the constructor or method invocation arguments if theConstraintViolation
is returned after validating the method or constructor parameters. Returnsnull
otherwise.- Returns:
- parameters of the method or constructor invocation or
null
- Since:
- 1.1
-
getExecutableReturnValue
Object getExecutableReturnValue()
Returns the return value of the constructor or method invocation if theConstraintViolation
is returned after validating the method or constructor return value. Returnsnull
if the method has no return value. Returnsnull
otherwise.- Returns:
- the method or constructor return value or
null
- Since:
- 1.1
-
getPropertyPath
Path getPropertyPath()
- Returns:
- the property path to the value from
rootBean
-
getInvalidValue
Object getInvalidValue()
Returns the value failing to pass the constraint. For cross-parameter constraints, anObject[]
representing the method invocation arguments is returned.- Returns:
- the value failing to pass the constraint
-
getConstraintDescriptor
ConstraintDescriptor<?> getConstraintDescriptor()
Returns the constraint metadata reported to fail. The returned instance is immutable.- Returns:
- constraint metadata
-
unwrap
<U> U unwrap(Class<U> type)
Returns an instance of the specified type allowing access to provider-specific APIs. If the Bean Validation provider implementation does not support the specified class,ValidationException
is thrown.- Parameters:
type
- the class of the object to be returned- Returns:
- an instance of the specified class
- Throws:
ValidationException
- if the provider does not support the call- Since:
- 1.1
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/validation/ConstraintViolation.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.