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

[hibernate-commits at lists.jboss.org]

Author: hardy.ferentschik
Date: 2009-05-25 09:47:53 -0400 (Mon, 25 May 2009)
New Revision: 16616

Modified:
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/Configuration.java
Log:
javadoc changes

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/Configuration.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/Configuration.java	2009-05-25 11:29:22 UTC (rev 16615)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/Configuration.java	2009-05-25 13:47:53 UTC (rev 16616)
@@ -21,8 +21,7 @@
 
 /**
  * Receives configuration information, selects the appropriate
- * Bean Validation provider and builds the appropriate
- * ValidatorFactory.
+ * Bean Validation provider and builds the appropriate <code>ValidatorFactory</code>.
  * <p/>
  * Usage:
  * <pre>
@@ -32,35 +31,36 @@
  *         .buildValidatorFactory();
  * </pre>
  * <p/>
- * <p/>
  * By default, the configuration information is retrieved from
- * META-INF/validation.xml
+ * <i>META-INF/validation.xml</i>.
  * It is possible to override the configuration retrieved from the XML file
- * by using one or more of the Configuration methods.
+ * by using one or more of the <code>Configuration</code> methods.
  * <p/>
- * The ValidationProviderResolver is specified at Configuration time
+ * The {@link ValidationProviderResolver) is specified at configuration time
  * (see {@link javax.validation.spi.ValidationProvider}).
- * If none is explicitely requested, the default ValidationProviderResolver is used.
+ * If none is explicitely requested, the default <code>ValidationProviderResolver</code> is used.
  * <p/>
  * The provider is selected in the following way:
- * - if a specific Configuration subclass is requested programmatically using
- * Validation.byProvider(Class), find the first provider matching it
- * - if a specific Configuration subclass is defined in META-INF/validation.xml,
- * find the first provider matching it
- * - otherwise, use the first provider returned by the ValidationProviderResolver
+ * <ul>
+ * <li>if a specific <code>Configuration</code> subclass is requested programmatically using
+ * <code>Validation.byProvider(Class)</code>, find the first provider matching it</li>
+ * <li>if a specific <code>Configuration</code> subclass is defined in <i>META-INF/validation.xml</i>,
+ * find the first provider matching it </li>
+ * <li>otherwise, use the first provider returned by the <code>ValidationProviderResolver<code></li>
+ * </ul>
  * <p/>
- * Implementations are not meant to be thread-safe
+ * Implementations are not meant to be thread-safe.
  *
  * @author Emmanuel Bernard
  */
 public interface Configuration<T extends Configuration<T>> {
 
 	/**
-	 * Ignore data from the META-INF/validation.xml file if this
+	 * Ignore data from the <i>META-INF/validation.xml</i> file if this
 	 * method is called.
 	 * This method is typically useful for containers that parse
-	 * META-INF/validation.xml themselves and pass the information
-	 * via the Configuration methods.
+	 * <i>META-INF/validation.xml</i> themselves and pass the information
+	 * via the <code>Configuration</code> methods.
 	 *
 	 * @return <code>this</code> following the chaining method pattern.
 	 */
@@ -69,7 +69,7 @@
 	/**
 	 * Defines the message interpolator used. Has priority over the configuration
 	 * based message interpolator.
-	 * If null is passed, the default message interpolator is used
+	 * If <code>null</code> is passed, the default message interpolator is used
 	 * (defined in XML or the specification default).
 	 *
 	 * @param interpolator message interpolator implementation.
@@ -81,7 +81,7 @@
 	/**
 	 * Defines the traversable resolver used. Has priority over the configuration
 	 * based traversable resolver.
-	 * If null is passed, the default traversable resolver is used
+	 * If <code>null</code> is passed, the default traversable resolver is used
 	 * (defined in XML or the specification default).
 	 *
 	 * @param resolver traversable resolver implementation.
@@ -126,13 +126,13 @@
 	 * Note: Using this non type-safe method is generally not recommended.
 	 * <p/>
 	 * It is more appropriate to use, if available, the type-safe equivalent provided
-	 * by a specific provider via its Configuration subclass.
+	 * by a specific provider via its <code>Configuration<code> subclass.
 	 * <code>ValidatorFactory factory = Validation.byProvider(ACMEConfiguration.class)
 	 * .configure()
 	 * .providerSpecificProperty(ACMEState.FAST)
 	 * .buildValidatorFactory();
 	 * </code>
-	 * This method is typically used by containers parsing META-INF/validation.xml
+	 * This method is typically used by containers parsing <i>META-INF/validation.xml</i>
 	 * themselves and injecting the state to the Configuration object.
 	 * <p/>
 	 * If a property with a given name is defined both via this method and in the
@@ -152,8 +152,10 @@
 	/**
 	 * Return an implementation of the MessageInterpolator interface following the
 	 * default MessageInterpolator defined in the specification:
-	 * - use the ValidationMessages resource bundle to load keys
-	 * - use Locale.getDefault()
+	 * <ul>
+	 * <li>use the ValidationMessages resource bundle to load keys</li>
+	 * <li>use Locale.getDefault()</li>
+	 * </ul>
 	 *
 	 * @return default MessageInterpolator implementation compliant with the specification
 	 */