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

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2009-07-07 08:02:51 -0400 (Tue, 07 Jul 2009)
New Revision: 17011

Added:
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/package-info.java
Modified:
   beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/Default.java
Log:
Javadoc improvement on Default

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/Default.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/Default.java	2009-07-07 09:04:46 UTC (rev 17010)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/Default.java	2009-07-07 12:02:51 UTC (rev 17011)
@@ -1,7 +1,13 @@
 package javax.validation.groups;
 
 /**
- * Default Bean Validation group
+ * Default Bean Validation group.
+ * Unless a list of group is explicitly defined:
+ * <ul>
+ *  <li>constraints belong to the Default group</li>
+ *  <li>validation apply on the Default group</li>
+ * </ul>
+ * Most structural constraints should belong to the default group.
  *
  * @author Emmanuel Bernard
  */

Added: beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/package-info.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/package-info.java	                        (rev 0)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/groups/package-info.java	2009-07-07 12:02:51 UTC (rev 17011)
@@ -0,0 +1,12 @@
+/**
+ * A group defines a subset of constraints. Instead of
+ * validating all constraints for a given object graph,
+ * only a subset is validated depending on the group targeted.
+ *
+ * Each constraint declaration defines the list of groups it belongs to.
+ * If no group is explicitly declared, a constraint belongs to the Default group.
+ *
+ * When applying validation, the list of target group is passed along.
+ * If no group is explicitly passed along, the Default group is used.
+ */
+package javax.validation.groups;
\ No newline at end of file