diff options
| author | Dominik Stadler <centic@apache.org> | 2021-11-02 13:18:35 +0000 |
|---|---|---|
| committer | Dominik Stadler <centic@apache.org> | 2021-11-02 13:18:35 +0000 |
| commit | da930c4f87259142cd868b1e6207284a0d67304d (patch) | |
| tree | 7307839447c6c0644714df0ebeb731de5a60315a /poi/src | |
| parent | cb306470148eafd8dd3092fc9c83f1033ccaec37 (diff) | |
| download | poi-da930c4f87259142cd868b1e6207284a0d67304d.tar.gz poi-da930c4f87259142cd868b1e6207284a0d67304d.zip | |
Add some more JavaDoc
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1894679 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'poi/src')
| -rw-r--r-- | poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java | 4 | ||||
| -rw-r--r-- | poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java | 22 |
2 files changed, 24 insertions, 2 deletions
diff --git a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index f1e190b89a..a9e0ed0a79 100644 --- a/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -247,7 +247,7 @@ public final class HSSFWorkbook extends POIDocument implements Workbook { public static int getMaxImageLength() { return MAX_IMAGE_LENGTH; } - + /** * Creates new HSSFWorkbook from scratch (start here!) */ @@ -789,7 +789,7 @@ public final class HSSFWorkbook extends POIDocument implements Workbook { * Returns the index of the sheet by his name * * @param name the sheet name - * @return index of the sheet (0 based) + * @return index of the sheet (0 based) or -1 if it was not found. */ @Override public int getSheetIndex(String name) { diff --git a/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java b/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java index c0469f7e5d..90600ec5a3 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java @@ -29,27 +29,49 @@ import org.apache.poi.util.Internal; */ @Internal public interface EvaluationWorkbook { + + /** + * Returns the name of the sheet at the given 0-based index. + * + * @param sheetIndex The 0-based index of the sheet + * @return The name of the sheet + * @throws IllegalArgumentException If the index is outside the indices of available sheets + */ String getSheetName(int sheetIndex); + /** * @return -1 if the specified sheet is from a different book */ int getSheetIndex(EvaluationSheet sheet); + /** * Finds a sheet index by case insensitive name. * @return the index of the sheet matching the specified name. -1 if not found */ int getSheetIndex(String sheetName); + /** + * Get the sheet identified by the given 0-based index. + * + * @param sheetIndex The 0-based index of the sheet + * @return The sheet + * @throws IllegalArgumentException If the index is outside the indices of available sheets + */ EvaluationSheet getSheet(int sheetIndex); /** * HSSF Only - fetch the external-style sheet details * <p>Return will have no workbook set if it's actually in our own workbook</p> + * @return The found sheet or null if not found + * @throws IllegalStateException If called with XSSF or SXSSF workbooks */ ExternalSheet getExternalSheet(int externSheetIndex); + /** * XSSF Only - fetch the external-style sheet details * <p>Return will have no workbook set if it's actually in our own workbook</p> + * @return The found sheet + * @throws IllegalStateException If called with HSSF workbooks */ ExternalSheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber); /** |