[hibernate-commits] Hibernate SVN: r17028 - in beanvalidation/trunk/validation-api/src/main/java/javax/validation: metadata and 1 other directory.

hibernate-commits at lists.jboss.org hibernate-commits at lists.jboss.org
Tue Jul 7 16:23:06 EDT 2009


Author: epbernard
Date: 2009-07-07 16:23:05 -0400 (Tue, 07 Jul 2009)
New Revision: 17028

Modified:
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/TraversableResolver.java
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/metadata/ElementDescriptor.java
Log:
Fix Javadoc typos and style

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java	2009-07-07 18:39:39 UTC (rev 17027)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/ConstraintValidatorContext.java	2009-07-07 20:23:05 UTC (rev 17028)
@@ -50,8 +50,9 @@
 	 * ErrorBuilder or any of its associated nested interfaces
 	 * an IllegalStateException is raised.
 	 * <p/>
-	 * If <code>isValid<code> returns <code>false</code>, a <code>ConstraintViolation</code> object will be built
-	 * per error including the default one unless {@link #disableDefaultError()} has been called.
+	 * If <code>isValid<code> returns <code>false</code>, a <code>ConstraintViolation</code>
+	 * object will be built per error including the default one unless
+	 * {@link #disableDefaultError()} has been called.
 	 * <p/>
 	 * <code>ConstraintViolation</code> objects generated from such a call
 	 * contain the same contextual information (root bean, path and so on) unless
@@ -67,12 +68,14 @@
 	 * 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" )
 	 *              .addSubNode( "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" )
 	 *              .addSubNode( "addresses" )
 	 *              .addSubNode( "country" )

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/TraversableResolver.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/TraversableResolver.java	2009-07-07 18:39:39 UTC (rev 17027)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/TraversableResolver.java	2009-07-07 20:23:05 UTC (rev 17028)
@@ -32,7 +32,8 @@
 	/**
 	 * Determine if Bean Validation is allowed to reach the property state
 	 *
-	 * @param traversableObject object hosting <code>traversableProperty</code>, null if validateValue is called
+	 * @param traversableObject object hosting <code>traversableProperty</code> or null
+	 *                          if validateValue is called
 	 * @param traversableProperty the traversable property.
 	 * @param rootBeanType type of the root object passed to the Validator.
 	 * @param pathToTraversableObject path from the root object to
@@ -56,7 +57,8 @@
 	 * Note that this method is called only if isReachable returns true for the same set of
 	 * arguments and if the property is marked as <code>@Valid</code>
 	 *
-	 * @param traversableObject object hosting <code>traversableProperty</code>, null if validateValue is called
+	 * @param traversableObject object hosting <code>traversableProperty</code> or null
+	 *                          if validateValue is called
 	 * @param traversableProperty the traversable property.
 	 * @param rootBeanType type of the root object passed to the Validator.
 	 * @param pathToTraversableObject path from the root object to

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java	2009-07-07 18:39:39 UTC (rev 17027)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validator.java	2009-07-07 20:23:05 UTC (rev 17028)
@@ -44,7 +44,7 @@
 	<T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups);
 
 	/**
-	 * Validates all constraints placed on the property named &lt;code&gt;propertyName&lt;/code&gt;
+	 * Validates all constraints placed on the property named <code>propertyName</code>
 	 * of <code>object</code>
 	 *
 	 * @param object object to validate

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/metadata/ElementDescriptor.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/metadata/ElementDescriptor.java	2009-07-07 18:39:39 UTC (rev 17027)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/metadata/ElementDescriptor.java	2009-07-07 20:23:05 UTC (rev 17028)
@@ -28,7 +28,8 @@
 public interface ElementDescriptor {
 
 	/**
-	 * @return <code>true</code> if at least one constraint declaration is present on the element, <code>false</code> otherwise.
+	 * @return <code>true</code> if at least one constraint declaration is
+	 *         present on the element, <code>false</code> otherwise.
 	 */
 	boolean hasConstraints();
 




More information about the hibernate-commits mailing list