Author: epbernard
Date: 2009-03-11 09:55:02 -0400 (Wed, 11 Mar 2009)
New Revision: 16145
Modified:
beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java
Log:
Clean JavaDoc
Modified:
beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java
===================================================================
---
beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java 2009-03-11
13:53:07 UTC (rev 16144)
+++
beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java 2009-03-11
13:55:02 UTC (rev 16145)
@@ -40,7 +40,8 @@
String getMessageTemplate();
/**
- * @return The root bean being validated.
+ * @return The root bean being validated. Null when returned by
+ * {@link javax.validation.Validator#validateValue(Class, String, Object,
Class[])}
*/
T getRootBean();
@@ -49,8 +50,8 @@
* If a property constraint, the bean instance hosting the property the
* constraint is applied on
*
- * @return the leaf bean the constraint is applied on or null if
Validator#validateValue
- * is used
+ * @return the leaf bean the constraint is applied on. Null when returned by
+ * {@link javax.validation.Validator#validateValue(Class, String, Object,
Class[])}
*/
Object getLeafBean();
Modified:
beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java
===================================================================
---
beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java 2009-03-11
13:53:07 UTC (rev 16144)
+++
beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java 2009-03-11
13:55:02 UTC (rev 16145)
@@ -64,7 +64,8 @@
* Validates all constraints on <code>propertyName</code> property
* if the property value is <code>value</code>
* <p/>
- * TODO express limitations of ConstraintViolation in this case
+ * <code>ConstraintViolation</code> objects return null for
+ * {@link ConstraintViolation#getRootBean()} and {@link
ConstraintViolation#getLeafBean()}
*
* @param beanType the bean type
* @param propertyName property to validate
Show replies by date