[hibernate-commits] Hibernate SVN: r16867 - beanvalidation/trunk/validation-api/src/main/java/javax/validation.

Author: hardy.ferentschik Date: 2009-06-22 17:07:00 -0400 (Mon, 22 Jun 2009) New Revision: 16867 Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java Log: javadoc Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java =================================================================== --- beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java 2009-06-22 21:06:03 UTC (rev 16866) +++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java 2009-06-22 21:07:00 UTC (rev 16867) @@ -58,28 +58,29 @@ * ConstraintValidatorContext * * Here are a few usage examples: - * <pre>//create new error with the default path the constraint - * //is located on + * <pre> + * {@code + * // create new error with the default path the constraint is located on * context.buildErrorWithMessageTemplate( "way too long" ) * .addError(); * - * //create new error in the "street" subnode of the default - * //path the constraint is located on + * // create new error in the "street" subnode of the default path the constraint is located on * context.buildErrorWithMessageTemplate( "way too long" ) * .inSubNode( "street" ) * .addError(); * - * //create new error in the "addresses["home"].city.name - * //subnode of the default path the constraint is located on + * //create new error in the "addresses["home"].city.name subnode of the default path the constraint is located on * context.buildErrorWithMessageTemplate( "this detail is wrong" ) * .inSubNode( "addresses" ) * .inSubNode( "country" ) * .inIterable().atKey( "home" ) * .inSubNode( "name" ) * .addError(); + * } * </pre> * * @param messageTemplate new uninterpolated error message. + * @return Returns an error builder */ ErrorBuilder buildErrorWithMessageTemplate(String messageTemplate); Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java =================================================================== --- beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java 2009-06-22 21:06:03 UTC (rev 16866) +++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintViolation.java 2009-06-22 21:07:00 UTC (rev 16867) @@ -18,7 +18,6 @@ package javax.validation; import javax.validation.metadata.ConstraintDescriptor; -import javax.validation.Path; /** * Describe a constraint violation. This object describe the error context as @@ -39,7 +38,7 @@ String getMessageTemplate(); /** - * @return The root bean being validated. Null when returned by + * @return The root bean being validated. Null when returned by * {@link javax.validation.Validator#validateValue(Class, String, Object, Class[])} */ T getRootBean(); @@ -53,14 +52,14 @@ * If a bean constraint, the bean instance the constraint is applied on * If a property constraint, the bean instance hosting the property the * constraint is applied on - * - * @return the leaf bean the constraint is applied on. Null when returned by + * + * @return the leaf bean the constraint is applied on. Null when returned by * {@link javax.validation.Validator#validateValue(Class, String, Object, Class[])} */ Object getLeafBean(); /** - * @return the property path to the value from <code>rootBean</code>. + * @return the property path to the value from {@code rootBean}. */ Path getPropertyPath(); @@ -72,7 +71,7 @@ /** * Constraint metadata reported to fail. * The returned instance is immutable. - * + * * @return constraint metadata */ ConstraintDescriptor<?> getConstraintDescriptor();