From 882d25e9e9cebf093b6b3d38b13e7963f60dbbc0 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Thu, 10 Jul 2008 22:39:53 +0000 Subject: [PATCH] Improve javadocs relating to getLastRowNumber git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@675792 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/poi/hssf/usermodel/HSSFSheet.java | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index e2e25c103..2b6ad4139 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -347,18 +347,25 @@ public final class HSSFSheet { } /** - * gets the first row on the sheet - * @return the number of the first logical row on the sheet + * Gets the first row on the sheet + * @return the number of the first logical row on the sheet, zero based */ - public int getFirstRowNum() { return firstrow; } /** - * gets the last row on the sheet - * @return last row contained n this sheet. + * Gets the number last row on the sheet. + * Owing to idiosyncrasies in the excel file + * format, if the result of calling this method + * is zero, you can't tell if that means there + * are zero rows on the sheet, or one at + * position zero. For that case, additionally + * call {@link #getPhysicalNumberOfRows()} to + * tell if there is a row at position zero + * or not. + * @return the number of the last row contained in this sheet, zero based. */ public int getLastRowNum()