HHH-10538 Fix the javadoc of TableInformation.getIndex(Identifier ind…

…exName)
hibernate · Feb 17, 2016 · 73abc5c · 73abc5c
1 parent 7ef7e20
commit 73abc5c
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/hibernate-core/src/main/java/org/hibernate/tool/schema/extract/spi/TableInformation.java b/hibernate-core/src/main/java/org/hibernate/tool/schema/extract/spi/TableInformation.java
@@ -78,7 +78,11 @@ public interface TableInformation {
 	public Iterable<IndexInformation> getIndexes();
 
 	/**
-	 * Obtain an iterable over all the table's defined indexes
+	 * Retrieve the named IndexInformation
+	 * 
+	 * @param indexName The index identifier (simple name)
+	 * 
+	 * @return The matching index information.  May return {@code null}
 	 */
 	public IndexInformation getIndex(Identifier indexName);
 }