[hibernate-commits] Hibernate SVN: r16816 - in beanvalidation/trunk/validation-api/src/main/java/javax/validation: constraints and 1 other directories.
hibernate-commits at lists.jboss.org
hibernate-commits at lists.jboss.org
Wed Jun 17 06:42:28 EDT 2009
Author: hardy.ferentschik
Date: 2009-06-17 06:42:27 -0400 (Wed, 17 Jun 2009)
New Revision: 16816
Modified:
beanvalidation/trunk/validation-api/src/main/java/javax/validation/OverridesAttribute.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validation.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMax.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMin.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Future.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Past.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Pattern.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Size.java
beanvalidation/trunk/validation-api/src/main/java/javax/validation/spi/ConfigurationState.java
Log:
Fixed javadoc warnings on @see tag and updates some of the text
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/OverridesAttribute.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/OverridesAttribute.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/OverridesAttribute.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -60,7 +60,7 @@
/**
* Defines several @OverridesAttribute annotations on the same element
- * @see {@link OverridesAttribute}
+ * @see OverridesAttribute
*/
@Documented
@Target({ METHOD })
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validation.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validation.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/Validation.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -38,12 +38,9 @@
* <ul>
* <li>
* The easiest approach is to build the default ValidatorFactory.
- * <pre>
- * ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
- * </pre>
+ * <pre>{@code ValidatorFactory factory = Validation.buildDefaultValidatorFactory();}</pre>
* In this case, the default validation provider resolver
* will be used to locate available providers.
- *
* The chosen provider is defined as followed:
* <ul>
* <li>if the XML configuration defines a provider, this provider is used</li>
@@ -57,27 +54,25 @@
* <code>ValidationProviderResolver</code>. The chosen
* <code>ValidationProvider</code> is then determined in the same way
* as in the default bootstrapping case (see above).
- * <pre>
- * Configuration<?> configuration = Validation
+ * <pre>{@code
+ * Configuration<?> configuration = Validation
* .byDefaultProvider()
* .providerResolver( new MyResolverStrategy() )
* .configure();
- * ValidatorFactory factory = configuration.buildValidatorFactory();
+ * ValidatorFactory factory = configuration.buildValidatorFactory();}
* </pre>
* </li>
- *
- * <p/>
* <li>
* The third approach allows you to specify explicitly and in
* a type safe fashion the expected provider.
*
* Optionally you can choose a custom <code>ValidationProviderResolver</code>.
- * <pre>
+ * <pre>{@code
* ACMEConfiguration configuration = Validation
* .byProvider(ACMEProvider.class)
* .providerResolver( new MyResolverStrategy() ) // optionally set the provider resolver
* .configure();
- * ValidatorFactory factory = configuration.buildValidatorFactory();
+ * ValidatorFactory factory = configuration.buildValidatorFactory();}
* </pre>
* </li>
* </ul>
@@ -93,7 +88,7 @@
* </ul>
*
* @author Emmanuel Bernard
- * @author Hardy Feretnschik
+ * @author Hardy Ferentschik
*/
public class Validation {
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMax.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMax.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMax.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -69,7 +69,7 @@
* Defines several @DecimalMax annotations on the same element
*
* @author Emmanuel Bernard
- * @see {@link DecimalMax}
+ * @see DecimalMax
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMin.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMin.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/DecimalMin.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -66,7 +66,7 @@
/**
* Defines several @DecimalMin annotations on the same element
- * @see {@link DecimalMin}
+ * @see DecimalMin
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Digits.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -41,7 +41,6 @@
* <code>null</code> elements are considered valid
*
* @author Emmanuel Bernard
- * @todo Is string supported or not?
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@@ -66,7 +65,7 @@
/**
* Defines several @Digits annotations on the same element
- * @see {@link Digits}
+ * @see Digits
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Future.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Future.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Future.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -56,7 +56,7 @@
/**
* Defines several @Future annotations on the same element
- * @see {@link Future}
+ * @see Future
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Max.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -63,7 +63,7 @@
/**
* Defines several @Max annotations on the same element
- * @see {@link Max}
+ * @see Max
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Min.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -63,7 +63,7 @@
/**
* Defines several @Min annotations on the same element
- * @see {@link Min}
+ * @see Min
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Past.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Past.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Past.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -56,7 +56,7 @@
/**
* Defines several @Past annotations on the same element
- * @see {@link Past}
+ * @see Past
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Pattern.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Pattern.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Pattern.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -130,7 +130,7 @@
/**
* Defines several @Pattern annotations on the same element
- * @see @link Pattern}
+ * @see Pattern
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Size.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Size.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/constraints/Size.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -64,7 +64,7 @@
/**
* Defines several @Size annotations on the same element
- * @see {@link Size}
+ * @see Size
*
* @author Emmanuel Bernard
*/
Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/spi/ConfigurationState.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/spi/ConfigurationState.java 2009-06-17 09:13:53 UTC (rev 16815)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/spi/ConfigurationState.java 2009-06-17 10:42:27 UTC (rev 16816)
@@ -18,8 +18,8 @@
package javax.validation.spi;
import java.io.InputStream;
+import java.util.Map;
import java.util.Set;
-import java.util.Map;
import javax.validation.ConstraintValidatorFactory;
import javax.validation.MessageInterpolator;
import javax.validation.TraversableResolver;
@@ -36,30 +36,36 @@
public interface ConfigurationState {
/**
- * returns true if Configuration.ignoreXMLConfiguration() has been called
+ * Returns true if Configuration.ignoreXMLConfiguration() has been called
* In this case, the ValidatorFactory must ignore META-INF/validation.xml
- * @return true if META-INF/validation.xml should be ignored
+ *
+ * @return {@code true} if META-INF/validation.xml should be ignored
*/
boolean isIgnoreXmlConfiguration();
/**
- * Message interpolator as defined in the following decreasing priority:
- * - set via the Configuration programmatic API
- * - defined in META-INF/validation.xml provided that ignoredXmlConfiguration
- * is false. In this case the instance is created via its no-arg constructor.
- * - null if undefined.
+ * Returns the message interpolator of this configuration..
+ * Message interpolator is defined in the following decreasing priority:
+ * <ul>
+ * <li>set via the Configuration programmatic API</li>
+ * <li>defined in META-INF/validation.xml provided that ignoredXmlConfiguration
+ * is false. In this case the instance is created via its no-arg constructor.</li>
+ * <li>{@code null} if undefined.</li>
+ * </ul>
*
* @return message provider instance or null if not defined
*/
MessageInterpolator getMessageInterpolator();
/**
- * Returns a set of stream corresponding to:
- * - mapping XML streams passed programmatically in Configuration
- * - mapping XML stream located in the resources defined in
+ * Returns a set of configuration streams.
+ * The streams are defined by:
+ * <ul>
+ * <li>mapping XML streams passed programmatically in Configuration</li>
+ * <li>mapping XML stream located in the resources defined in</li>
* META-INF/validation.xml (constraint-mapping element)
- *
- * Streams represented in the XML configuration and opened by the
+ * </ul>
+ * Streams represented in the XML configuration and opened by the
* configuration implementation must be closed by the configuration
* implementation after the ValidatorFactory creation (or if an exception
* occurs).
@@ -69,36 +75,44 @@
Set<InputStream> getMappingStreams();
/**
- * ConstraintValidatorFactory implementation as defined in the following
+ * Returns the constraint validator factory of this configuration.
+ * The {@code ConstraintValidatorFactory} implementation is defined in the following
* decreasing priority:
- * - set via the Configuration programmatic API
- * - defined in META-INF/validation.xml provided that ignoredXmlConfiguration
- * is false. In this case the instance is created via its no-arg constructor.
- * - null if undefined.
+ * <ul>
+ * <li>set via the Configuration programmatic API</li>
+ * <li>defined in META-INF/validation.xml provided that ignoredXmlConfiguration
+ * is false. In this case the instance is created via its no-arg constructor.</li>
+ * <li>{@code null} if undefined.</li>
+ * </ul>
*
- * @return factory instance or null if not defined
+ * @return factory instance or {@code null} if not defined
*/
ConstraintValidatorFactory getConstraintValidatorFactory();
/**
- * TraversableResolver as defined in the following decreasing priority:
- * - set via the Configuration programmatic API
- * - defined in META-INF/validation.xml provided that ignoredXmlConfiguration
- * is false. In this case the instance is created via its no-arg constructor.
- * - null if undefined.
+ * Returns the traversable resolver for this configuration.
+ * TraversableResolver is defined in the following decreasing priority:
+ * <ul>
+ * <li>set via the Configuration programmatic API</li>
+ * <li>defined in META-INF/validation.xml provided that ignoredXmlConfiguration
+ * is false. In this case the instance is created via its no-arg constructor.</li>
+ * <li>{@code null} if undefined.</li>
+ * </ul>
*
- * @return traversable provider instance or null if not defined
+ * @return traversable provider instance or {@code null} if not defined
*/
TraversableResolver getTraversableResolver();
/**
- * return non type-safe properties defined via:
- * - Configuration.addProperty(String, String)
- * - META-INF/validation.xml provided that ignoredXmlConfiguration
+ * Returns a map of non type-safe custom properties.
+ * Properties defined via:
+ * <ul>
+ * <li>Configuration.addProperty(String, String)</li>
+ * <li>META-INF/validation.xml provided that ignoredXmlConfiguration</li>
* is false.
- *
+ * </ul>
* If a property is defined both programmatically and in XML,
- * the value defined programmatically has priority
+ * the value defined programmatically has priority
*
* @return Map whose key is the property key and the value the property value
*/
More information about the hibernate-commits
mailing list