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

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2009-10-03 11:39:37 -0400 (Sat, 03 Oct 2009)
New Revision: 17616

Added:
   beanvalidation/api/trunk/src/main/java/javax/validation/metadata/Scope.java
Modified:
   beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java
Log:
Make the API extensible for metadata navigation (ie restrict the list of ConstraintDescriptors).

Modified: beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java
===================================================================
--- beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java	2009-10-03 12:27:42 UTC (rev 17615)
+++ beanvalidation/api/trunk/src/main/java/javax/validation/metadata/ElementDescriptor.java	2009-10-03 15:39:37 UTC (rev 17616)
@@ -18,6 +18,7 @@
 package javax.validation.metadata;
 
 import java.util.Set;
+import java.lang.annotation.ElementType;
 
 /**
  * Describes a validated element (class, field or property).
@@ -43,6 +44,7 @@
 	 * empty <code>Set</code> if none are present.
 	 *
 	 * @return <code>Set</code> of constraint descriptors for this element
+	 * @deprecated {@link #findConstraints()}
 	 */
 	Set<ConstraintDescriptor<?>> getConstraintDescriptors();
 
@@ -56,6 +58,81 @@
 	 *
 	 * @param groups groups targeted
 	 * @return list of matching ConstraintDescriptors
+	 * @deprecated {@link #findConstraints()}
 	 */
 	Set<ConstraintDescriptor<?>> getUnorderedConstraintDescriptorsMatchingGroups(Class<?>... groups);
+
+	/**
+	 * Find constraints and potentially restricting to certain criteria.
+	 *
+	 * @return ConstraintFinder object.
+	 */
+	ConstraintFinder findConstraints();
+
+	/**
+	 * Declare restrictions on how constraints are retrieved.
+	 * Restrictions are cumulative.
+	 *
+	 * A ConstraintFinder is not thread-safe. The set of matching
+	 * <code>ConstraintDescriptor</code> is.
+	 */
+	interface ConstraintFinder {
+		/**
+		 * Restrict to the constraints matching a given set of groups for this element
+		 *
+		 * This method respects group sequences and group inheritance (including
+		 * class-level <code>Default</code> group overriding) but does not return
+		 * <code>ConstraintDescriptor</code>s in any particular order.
+		 * Specifically, ordering of the group sequence is not respected.
+		 *
+		 * @param groups groups targeted
+		 *
+		 * @return <code>this</code> using the chaining method pattern
+		 */
+		ConstraintFinder unorderedAndMatchingGroups(Class<?>... groups);
+
+		/**
+		 * Restrict to the constraints matching the provided scope for this element.
+		 *
+		 * Defaults to <code>Scope.HIERARCHY</code>
+		 *
+		 * @param scope exected scope
+		 * @return <code>this</code> using the chaining method pattern
+		 */
+		ConstraintFinder lookingAt(Scope scope);
+
+		/**
+		 * Restrict to the constraints hosted on the listed <code>types</code>
+		 * for a given element.
+		 *
+		 * Default to all possible types of the element.
+		 *
+		 * Typically used to restrict to fields (<code>FIELD</code>)
+		 * or getters (<code>METHOD</code>)
+		 *
+		 * @param types targeted types
+		 * @return <code>this</code> using the chaining method pattern
+		 */
+		ConstraintFinder declaredOn(ElementType... types);
+
+		/**
+		 * Retrieve the constraint descriptors following the defined
+		 * restrictions and hosted on the element described by
+		 * <code>ElementDescriptor</code>
+		 *
+		 * @return matching constraint descriptors
+		 */
+		Set<ConstraintDescriptor<?>> getConstraintDescriptors();
+
+		/**
+		 * Returns <code>true</code> if at least one constraint declaration
+		 * matching the restrictions is present on the element,
+		 * <code>false</code> otherwise.
+		 *
+		 * @return is there any constraint
+		 */
+		boolean hasConstraints();
+
+	}
+
 }

Added: beanvalidation/api/trunk/src/main/java/javax/validation/metadata/Scope.java
===================================================================
--- beanvalidation/api/trunk/src/main/java/javax/validation/metadata/Scope.java	                        (rev 0)
+++ beanvalidation/api/trunk/src/main/java/javax/validation/metadata/Scope.java	2009-10-03 15:39:37 UTC (rev 17616)
@@ -0,0 +1,36 @@
+// $Id: ElementDescriptor.java 17590 2009-09-30 18:11:35Z epbernard $
+/*
+* JBoss, Home of Professional Open Source
+* Copyright 2008, Red Hat, Inc. and/or its affiliates, and individual contributors
+* by the @authors tag. See the copyright.txt in the distribution for a
+* full listing of individual contributors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+* http://www.apache.org/licenses/LICENSE-2.0
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+package javax.validation.metadata;
+
+/**
+	 * Scope looked at when discovering constraints
+ */
+public enum Scope {
+	/**
+	 * Look for constraints declared on the class-level element
+	 * and ingnore inheritance and elements with the same name in
+	 * the class hierarchy.
+	 */
+	LOCAL_ELEMENT,
+
+	/**
+	 * Look for constraints declared on all elements of the class hierarchy
+	 * with the same name.
+	 */
+	HIERARCHY
+}