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

[hibernate-commits at lists.jboss.org]

Author: hardy.ferentschik
Date: 2009-06-23 08:57:02 -0400 (Tue, 23 Jun 2009)
New Revision: 16901

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

Modified: beanvalidation/trunk/validation-api/src/main/java/javax/validation/Path.java
===================================================================
--- beanvalidation/trunk/validation-api/src/main/java/javax/validation/Path.java	2009-06-23 12:56:46 UTC (rev 16900)
+++ beanvalidation/trunk/validation-api/src/main/java/javax/validation/Path.java	2009-06-23 12:57:02 UTC (rev 16901)
@@ -16,7 +16,7 @@
 	 */
 	interface Node {
 		/**
-		 * Property name the node represents
+		 * @return Property name the node represents
 		 * or null if the leaf node and representing an entity
 		 * (in particular the node representing the root object
 		 * has its name null)
@@ -24,19 +24,19 @@
 		String getName();
 
 		/**
-		 * True if the node represents an object contained in an Iterable
+		 * @return True if the node represents an object contained in an Iterable
 		 * or in a Map.
 		 */
 		boolean isInIterable();
 
 		/**
-		 * The index the node is placed in if contained
+		 * @return The index the node is placed in if contained
 		 * in an array or List. Null otherwise.
 		 */
 		Integer getIndex();
 
 		/**
-		 * The key the node is placed in if contained
+		 * @return The key the node is placed in if contained
 		 * in a Map. Null otherwise.
 		 */
 		Object getKey();