From cfea03329eea7e2800d0850c41fbbba5482e757a Mon Sep 17 00:00:00 2001 From: Javen O'Neal Date: Fri, 10 Jun 2016 09:16:41 +0000 Subject: [PATCH] fix javadocs git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1747671 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/poi/ss/usermodel/Table.java | 21 +++++++++++-------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/src/java/org/apache/poi/ss/usermodel/Table.java b/src/java/org/apache/poi/ss/usermodel/Table.java index 8f7140e7c4..8a189d6bd6 100644 --- a/src/java/org/apache/poi/ss/usermodel/Table.java +++ b/src/java/org/apache/poi/ss/usermodel/Table.java @@ -34,27 +34,28 @@ public interface Table { Pattern isStructuredReference = Pattern.compile("[a-zA-Z_\\\\][a-zA-Z0-9._]*\\[.*\\]"); /** - * Get the top-left col index - * @return + * Get the top-left column index relative to the sheet + * @return table start column index on sheet */ int getStartColIndex(); /** - * Get the top-left row index - * @return + * Get the top-left row index on the sheet + * @return table start row index on sheet */ int getStartRowIndex(); /** - * Get the bottom-right col index - * @return + * Get the bottom-right column index on the sheet + * @return table end column index on sheet */ int getEndColIndex(); /** * Get the bottom-right row index - * @return + * @return table end row index on sheet */ int getEndRowIndex(); /** * Get the name of the table. + * @return table name */ String getName(); @@ -63,14 +64,16 @@ public interface Table { * Note this list is lazily loaded and cached for performance. * Changes to the underlying table structure are not reflected in later calls * unless XSSFTable.updateHeaders() is called to reset the cache. + * @param columnHeader the column header name to get the table column index of + * @return column index corresponding to columnHeader */ - int findColumnIndex(String column); + int findColumnIndex(String columnHeader); /** * Returns the sheet name that the table belongs to. */ String getSheetName(); /** - * Returns true iff the table has 'Totals' row + * Returns true iff the table has a 'Totals' row */ boolean isHasTotalsRow(); -- 2.39.5