Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add some more JavaDoc 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1894679 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2021-11-02 13:18:35 +00:00
parent cb30647014
commit da930c4f87
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
poi/src/main/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -247,7 +247,7 @@ public final class HSSFWorkbook extends POIDocument implements Workbook {
public static int getMaxImageLength() { public static int getMaxImageLength() {
return MAX_IMAGE_LENGTH; return MAX_IMAGE_LENGTH;
} }
/** /**
* Creates new HSSFWorkbook from scratch (start here!) * 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 * Returns the index of the sheet by his name
* *
* @param name the sheet 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 @Override
public int getSheetIndex(String name) { public int getSheetIndex(String name) {

22
poi/src/main/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
View File

@ -29,27 +29,49 @@ import org.apache.poi.util.Internal;
*/ */
@Internal @Internal
public interface EvaluationWorkbook { 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); String getSheetName(int sheetIndex);
/** /**
* @return -1 if the specified sheet is from a different book * @return -1 if the specified sheet is from a different book
*/ */
int getSheetIndex(EvaluationSheet sheet); int getSheetIndex(EvaluationSheet sheet);
/** /**
* Finds a sheet index by case insensitive name. * Finds a sheet index by case insensitive name.
* @return the index of the sheet matching the specified name. -1 if not found * @return the index of the sheet matching the specified name. -1 if not found
*/ */
int getSheetIndex(String sheetName); 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); EvaluationSheet getSheet(int sheetIndex);
/** /**
* HSSF Only - fetch the external-style sheet details * HSSF Only - fetch the external-style sheet details
* <p>Return will have no workbook set if it's actually in our own workbook</p> * <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); ExternalSheet getExternalSheet(int externSheetIndex);
/** /**
* XSSF Only - fetch the external-style sheet details * XSSF Only - fetch the external-style sheet details
* <p>Return will have no workbook set if it's actually in our own workbook</p> * <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); ExternalSheet getExternalSheet(String firstSheetName, String lastSheetName, int externalWorkbookNumber);
/** /**