From 2517aa0e42c7cefbe667548a5782a7f7b1564c35 Mon Sep 17 00:00:00 2001 From: Yegor Kozlov Date: Fri, 7 Nov 2008 16:57:23 +0000 Subject: [PATCH] javadocs cleanup git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@712196 13f79535-47bb-0310-9956-ffa450edef68 --- build.xml | 6 +- .../org/apache/poi/hssf/dev/BiffViewer.java | 2 +- src/java/org/apache/poi/hssf/model/Sheet.java | 15 +- .../poi/hssf/record/CFHeaderRecord.java | 2 +- .../apache/poi/hssf/record/CFRuleRecord.java | 2 +- .../poi/hssf/record/ColumnInfoRecord.java | 12 +- .../apache/poi/hssf/record/DBCellRecord.java | 2 +- .../org/apache/poi/hssf/record/DVRecord.java | 8 +- .../poi/hssf/record/FileSharingRecord.java | 8 +- .../poi/hssf/record/HyperlinkRecord.java | 2 +- .../apache/poi/hssf/record/NameRecord.java | 2 +- .../hssf/record/NoteStructureSubRecord.java | 7 +- .../poi/hssf/record/RecordInputStream.java | 3 +- .../apache/poi/hssf/record/StyleRecord.java | 2 +- .../apache/poi/hssf/record/SupBookRecord.java | 4 +- .../record/aggregates/CFRecordsAggregate.java | 4 +- .../aggregates/RowRecordsAggregate.java | 2 +- .../record/aggregates/SharedValueManager.java | 7 - .../poi/hssf/record/cf/BorderFormatting.java | 10 +- .../poi/hssf/record/cf/CellRangeUtil.java | 2 +- .../poi/hssf/record/cf/FontFormatting.java | 8 +- .../apache/poi/hssf/record/formula/Ptg.java | 2 +- .../record/formula/eval/OperandResolver.java | 2 +- .../formula/functions/TextFunction.java | 4 +- .../apache/poi/hssf/usermodel/HSSFCell.java | 3 +- .../poi/hssf/usermodel/HSSFCellStyle.java | 30 +- .../usermodel/HSSFConditionalFormatting.java | 2 +- .../hssf/usermodel/HSSFDataValidation.java | 2 +- .../hssf/usermodel/HSSFFontFormatting.java | 7 +- .../hssf/usermodel/HSSFFormulaEvaluator.java | 6 +- .../hssf/usermodel/HSSFPatternFormatting.java | 9 +- .../apache/poi/hssf/usermodel/HSSFRow.java | 4 +- .../apache/poi/hssf/usermodel/HSSFSheet.java | 2 +- .../HSSFSheetConditionalFormatting.java | 6 +- .../poi/hssf/usermodel/HSSFWorkbook.java | 2 +- .../apache/poi/ss/formula/EvaluationCell.java | 2 +- .../ss/formula/ExternSheetReferenceToken.java | 2 +- .../ss/formula/WorkbookDependentFormula.java | 2 +- .../poi/ss/formula/WorkbookEvaluator.java | 2 +- .../poi/ss/usermodel/FormulaEvaluator.java | 11 +- .../apache/poi/ss/usermodel/HeaderFooter.java | 4 +- .../poi/ss/util/CellRangeAddressBase.java | 8 +- .../poi/ss/util/CellRangeAddressList.java | 1 - src/java/org/apache/poi/ss/util/Region.java | 2 +- src/java/org/apache/poi/util/StringUtil.java | 2 +- .../org/apache/poi/util/PackageHelper.java | 4 +- .../xssf/model/XSSFChildContainingModel.java | 2 +- .../apache/poi/xssf/usermodel/XSSFCell.java | 2 +- .../poi/xssf/usermodel/XSSFCellStyle.java | 401 +++++++------- .../apache/poi/xssf/usermodel/XSSFFont.java | 2 +- .../xssf/usermodel/XSSFFormulaEvaluator.java | 490 +++++++++--------- .../poi/xssf/usermodel/XSSFPicture.java | 3 +- .../poi/xssf/usermodel/XSSFPictureData.java | 12 +- .../apache/poi/xssf/usermodel/XSSFRow.java | 4 +- .../poi/xssf/usermodel/XSSFWorkbook.java | 24 +- .../extensions/XSSFHeaderFooter.java | 4 - .../apache/poi/hslf/model/ActiveXShape.java | 2 +- .../org/apache/poi/hslf/model/MovieShape.java | 2 +- .../org/apache/poi/hslf/model/OLEShape.java | 1 - .../poi/hslf/record/AnimationInfoAtom.java | 4 +- .../poi/hslf/record/HeadersFootersAtom.java | 18 +- .../src/org/apache/poi/hsmf/MAPIMessage.java | 8 - .../org/apache/poi/hsmf/datatypes/Chunk.java | 4 - .../poi/hsmf/parsers/POIFSChunkParser.java | 7 +- .../apache/poi/hwpf/model/PicturesTable.java | 2 +- .../org/apache/poi/hwpf/model/TextPiece.java | 1 - .../apache/poi/hwpf/model/TextPieceTable.java | 2 +- .../poi/hwpf/usermodel/HeaderStories.java | 2 - .../usermodel/TestHSSFFormulaEvaluator.java | 2 +- .../poi/ss/formula/TestCellCacheEntry.java | 2 +- .../poi/ss/formula/TestEvaluationCache.java | 2 +- 71 files changed, 577 insertions(+), 657 deletions(-) diff --git a/build.xml b/build.xml index e44cd69c7..617366fd7 100644 --- a/build.xml +++ b/build.xml @@ -1010,7 +1010,7 @@ FORREST_HOME environment variable! warn-unless-xslt-is-available" description="Generates the API documentation"> + windowtitle="POI API Documentation" use="true" version="true" maxmemory="256M"> @@ -1022,7 +1022,7 @@ FORREST_HOME environment variable! - + @@ -1030,7 +1030,7 @@ FORREST_HOME environment variable! - + diff --git a/src/java/org/apache/poi/hssf/dev/BiffViewer.java b/src/java/org/apache/poi/hssf/dev/BiffViewer.java index 6d2def084..c5b29871c 100644 --- a/src/java/org/apache/poi/hssf/dev/BiffViewer.java +++ b/src/java/org/apache/poi/hssf/dev/BiffViewer.java @@ -52,7 +52,7 @@ public final class BiffViewer { /** * Create an array of records from an input stream * - *@param in the InputStream from which the records will be obtained + *@param is the InputStream from which the records will be obtained *@return an array of Records created from the InputStream *@exception RecordFormatException on error processing the InputStream */ diff --git a/src/java/org/apache/poi/hssf/model/Sheet.java b/src/java/org/apache/poi/hssf/model/Sheet.java index 901402eff..23d6ec115 100644 --- a/src/java/org/apache/poi/hssf/model/Sheet.java +++ b/src/java/org/apache/poi/hssf/model/Sheet.java @@ -148,9 +148,7 @@ public final class Sheet implements Model { * to the passed in records and references to those records held. This function * is normally called via Workbook. * - * @param inRecs array containing those records in the sheet in sequence (normally obtained from RecordFactory) - * @param sheetnum integer specifying the sheet's number (0,1 or 2 in this release) - * @param offset of the sheet's BOF record + * @param rs the stream to read records from * * @return Sheet object with all values set to those read from the file * @@ -653,7 +651,6 @@ public final class Sheet implements Model { * at what this sets it to. * * @param row the row record to be added - * @see #setLoc(int) */ public void addRow(RowRecord row) @@ -706,7 +703,6 @@ public final class Sheet implements Model { * subsequent calls will return values in (physical) sequence or NULL when you get to the end. * * @return CellValueRecordInterface representing the next value record or NULL if there are no more - * @see #setLoc(int) */ public CellValueRecordInterface[] getValueRecords() { return _rowsAggregate.getValueRecords(); @@ -723,8 +719,6 @@ public final class Sheet implements Model { * subsequent calls will return rows in (physical) sequence or NULL when you get to the end. * * @return RowRecord representing the next row record or NULL if there are no more - * @see #setLoc(int) - * */ public RowRecord getNextRow() { if (rowRecIterator == null) @@ -751,7 +745,6 @@ public final class Sheet implements Model { * * @param rownum which row to return (careful with LOC) * @return RowRecord representing the next row record or NULL if there are no more - * @see #setLoc(int) * */ public RowRecord getRow(int rownum) { @@ -985,7 +978,7 @@ public final class Sheet implements Model { * @param columnIndex index * @see org.apache.poi.hssf.record.DefaultColWidthRecord * @see org.apache.poi.hssf.record.ColumnInfoRecord - * @see #setColumnWidth(short,short) + * @see #setColumnWidth(int, int) * @return column width in units of 1/256th of a character width */ @@ -1036,10 +1029,10 @@ public final class Sheet implements Model { /** * Get the hidden property for a given column. - * @param column index + * @param columnIndex column index * @see org.apache.poi.hssf.record.DefaultColWidthRecord * @see org.apache.poi.hssf.record.ColumnInfoRecord - * @see #setColumnHidden(short,boolean) + * @see #setColumnHidden(int, boolean) * @return whether the column is hidden or not. */ public boolean isColumnHidden(int columnIndex) { diff --git a/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java b/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java index 2be58b0d9..eeadd388a 100644 --- a/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java +++ b/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java @@ -87,7 +87,7 @@ public final class CFHeaderRecord extends Record { /** * Set cell ranges list to a single cell range and * modify the enclosing cell range accordingly. - * @param List cellRanges - list of CellRange objects + * @param cellRanges - list of CellRange objects */ public void setCellRanges(CellRangeAddress[] cellRanges) { diff --git a/src/java/org/apache/poi/hssf/record/CFRuleRecord.java b/src/java/org/apache/poi/hssf/record/CFRuleRecord.java index f9e11dbaf..7ec14d06d 100644 --- a/src/java/org/apache/poi/hssf/record/CFRuleRecord.java +++ b/src/java/org/apache/poi/hssf/record/CFRuleRecord.java @@ -437,7 +437,7 @@ public final class CFRuleRecord extends Record { * Subclasses should implement this so that their data is passed back in a * byte array. * - * @param offset to begin writing at + * @param pOffset to begin writing at * @param data byte array containing instance data * @return number of bytes written */ diff --git a/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java b/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java index 1fc0907f9..5cd4a1043 100644 --- a/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java +++ b/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java @@ -120,7 +120,7 @@ public final class ColumnInfoRecord extends Record { /** * set whether or not these cells are hidden * @param ishidden - whether the cells are hidden. - * @see #setOptions(short) + * @see #setOptions(int) */ public void setHidden(boolean ishidden) @@ -130,7 +130,7 @@ public final class ColumnInfoRecord extends Record { /** * set the outline level for the cells - * @see #setOptions(short) + * @see #setOptions(int) * @param olevel -outline level for the cells */ @@ -142,7 +142,7 @@ public final class ColumnInfoRecord extends Record { /** * set whether the cells are collapsed * @param iscollapsed - wether the cells are collapsed - * @see #setOptions(short) + * @see #setOptions(int) */ public void setCollapsed(boolean iscollapsed) @@ -206,7 +206,7 @@ public final class ColumnInfoRecord extends Record { /** * get whether or not these cells are hidden * @return whether the cells are hidden. - * @see #setOptions(short) + * @see #setOptions(int) */ public boolean getHidden() @@ -216,7 +216,7 @@ public final class ColumnInfoRecord extends Record { /** * get the outline level for the cells - * @see #setOptions(short) + * @see #setOptions(int) * @return outline level for the cells */ @@ -228,7 +228,7 @@ public final class ColumnInfoRecord extends Record { /** * get whether the cells are collapsed * @return wether the cells are collapsed - * @see #setOptions(short) + * @see #setOptions(int) */ public boolean getCollapsed() diff --git a/src/java/org/apache/poi/hssf/record/DBCellRecord.java b/src/java/org/apache/poi/hssf/record/DBCellRecord.java index fef70667d..cb0afcbda 100644 --- a/src/java/org/apache/poi/hssf/record/DBCellRecord.java +++ b/src/java/org/apache/poi/hssf/record/DBCellRecord.java @@ -148,7 +148,7 @@ public final class DBCellRecord extends Record { } /** - * @returns the size of the group of DBCellRecords needed to encode + * @return the size of the group of DBCellRecords needed to encode * the specified number of blocks and rows */ public static int calculateSizeOfRecords(int nBlocks, int nRows) { diff --git a/src/java/org/apache/poi/hssf/record/DVRecord.java b/src/java/org/apache/poi/hssf/record/DVRecord.java index c552a39f2..f09b31f41 100644 --- a/src/java/org/apache/poi/hssf/record/DVRecord.java +++ b/src/java/org/apache/poi/hssf/record/DVRecord.java @@ -66,7 +66,7 @@ public final class DVRecord extends Record { /** * Option flags field * - * @see org.apache.poi.hssf.util.HSSFDataValidation utility class + * @see HSSFDataValidation utility class */ private static final BitField opt_data_type = new BitField(0x0000000F); private static final BitField opt_error_style = new BitField(0x00000070); @@ -133,7 +133,7 @@ public final class DVRecord extends Record { // --> start option flags /** * @return the condition data type - * @see DVConstraint.ValidationType + * @see org.apache.poi.hssf.usermodel.DVConstraint.ValidationType */ public int getDataType() { return opt_data_type.getValue(_option_flags); @@ -141,7 +141,7 @@ public final class DVRecord extends Record { /** * @return the condition error style - * @see HSSFDataValidation.ErrorStyle + * @see org.apache.poi.hssf.usermodel.HSSFDataValidation.ErrorStyle */ public int getErrorStyle() { return opt_error_style.getValue(_option_flags); @@ -189,7 +189,7 @@ public final class DVRecord extends Record { /** * get the condition operator * @return the condition operator - * @see org.apache.poi.hssf.util.HSSFDataValidation utility class + * @see HSSFDataValidation utility class */ public int getConditionOperator() { return opt_condition_operator.getValue(_option_flags); diff --git a/src/java/org/apache/poi/hssf/record/FileSharingRecord.java b/src/java/org/apache/poi/hssf/record/FileSharingRecord.java index 54d94d9f8..f6b3e6340 100644 --- a/src/java/org/apache/poi/hssf/record/FileSharingRecord.java +++ b/src/java/org/apache/poi/hssf/record/FileSharingRecord.java @@ -90,28 +90,28 @@ public final class FileSharingRecord extends Record { } /** - * @param hashed password + * @param password hashed password */ public void setPassword(short password) { field_2_password = password; } /** - * @returns password hashed with hashPassword() (very lame) + * @return password hashed with hashPassword() (very lame) */ public short getPassword() { return field_2_password; } /** - * @returns byte representing the length of the username field + * @return byte representing the length of the username field */ public short getUsernameLength() { return (short) field_3_username_value.length(); } /** - * @returns username of the user that created the file + * @return username of the user that created the file */ public String getUsername() { return field_3_username_value; diff --git a/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java b/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java index f7904a100..d4d824f89 100644 --- a/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java +++ b/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java @@ -211,7 +211,7 @@ public final class HyperlinkRecord extends Record { } /** - * Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER} + * Returns a 16-byte guid identifier. Seems to always equal {@link #STD_MONIKER} * * @return 16-byte guid identifier */ diff --git a/src/java/org/apache/poi/hssf/record/NameRecord.java b/src/java/org/apache/poi/hssf/record/NameRecord.java index f27fb2d88..72ba2e4ca 100644 --- a/src/java/org/apache/poi/hssf/record/NameRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameRecord.java @@ -523,7 +523,7 @@ public final class NameRecord extends Record { * called by the constructor, should set class level fields. Should throw * runtime exception for bad/icomplete data. * - * @param in the RecordInputstream to read the record from + * @param ris the RecordInputstream to read the record from */ public NameRecord(RecordInputStream ris) { LittleEndianInput in = ris; diff --git a/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java b/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java index f2b84d327..fff3f39f3 100644 --- a/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java @@ -40,8 +40,6 @@ public final class NoteStructureSubRecord extends SubRecord { /** * Construct a new NoteStructureSubRecord and * fill its data with the default values - * @param size - * @param in */ public NoteStructureSubRecord() { @@ -80,10 +78,7 @@ public final class NoteStructureSubRecord extends SubRecord { /** * Serialize the record data into the supplied array of bytes * - * @param offset offset in the data - * @param data the data to serialize into - * - * @return size of the record + * @param out the stream to serialize into */ public void serialize(LittleEndianOutput out) { out.writeShort(sid); diff --git a/src/java/org/apache/poi/hssf/record/RecordInputStream.java b/src/java/org/apache/poi/hssf/record/RecordInputStream.java index 2f275ed92..b7b47ffd6 100755 --- a/src/java/org/apache/poi/hssf/record/RecordInputStream.java +++ b/src/java/org/apache/poi/hssf/record/RecordInputStream.java @@ -76,7 +76,7 @@ public final class RecordInputStream extends InputStream implements LittleEndian } /** - * @returns the number of bytes available in the current BIFF record + * @return the number of bytes available in the current BIFF record * @see #remaining() */ public int available() { @@ -216,7 +216,6 @@ public final class RecordInputStream extends InputStream implements LittleEndian /** * Reads a 16 bit, unsigned value. - * @return */ public int readUShort() { checkRecordPosition(LittleEndian.SHORT_SIZE); diff --git a/src/java/org/apache/poi/hssf/record/StyleRecord.java b/src/java/org/apache/poi/hssf/record/StyleRecord.java index af60e6924..9994dfcf7 100644 --- a/src/java/org/apache/poi/hssf/record/StyleRecord.java +++ b/src/java/org/apache/poi/hssf/record/StyleRecord.java @@ -94,7 +94,7 @@ public final class StyleRecord extends Record { /** * get the actual index of the style extended format record - * @see #getIndex() + * @see #getXFIndex() * @return index of the xf record */ public int getXFIndex() { diff --git a/src/java/org/apache/poi/hssf/record/SupBookRecord.java b/src/java/org/apache/poi/hssf/record/SupBookRecord.java index 5cbfd42d6..8ff2e26ed 100644 --- a/src/java/org/apache/poi/hssf/record/SupBookRecord.java +++ b/src/java/org/apache/poi/hssf/record/SupBookRecord.java @@ -80,9 +80,7 @@ public final class SupBookRecord extends Record { * called by the constructor, should set class level fields. Should throw * runtime exception for bad/incomplete data. * - * @param data raw data - * @param size size of data - * @param offset of the record's data (provided a big array of the file) + * @param in the stream to read from */ public SupBookRecord(RecordInputStream in) { int recLen = in.remaining(); diff --git a/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java index b9e4d833b..73f39db77 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java @@ -74,8 +74,7 @@ public final class CFRecordsAggregate extends RecordAggregate { /** * Create CFRecordsAggregate from a list of CF Records - * @param recs - list of {@link Record} objects - * @param offset - position of {@link CFHeaderRecord} object in the list of Record objects + * @param rs - the stream to read from * @return CFRecordsAggregate object */ public static CFRecordsAggregate createCFAggregate(RecordStream rs) { @@ -98,7 +97,6 @@ public final class CFRecordsAggregate extends RecordAggregate { /** * Create a deep clone of the record - * @return */ public CFRecordsAggregate cloneCFAggregate() { diff --git a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java index 2a2497f36..0d57edbc4 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java @@ -358,7 +358,7 @@ public final class RowRecordsAggregate extends RecordAggregate { /** * Create a row record. * - * @param row number + * @param rowNumber row number * @return RowRecord created for the passed in row number * @see org.apache.poi.hssf.record.RowRecord */ diff --git a/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java b/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java index 98eebe088..92eece49a 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java @@ -106,13 +106,6 @@ public final class SharedValueManager { _groupsBySharedFormulaRecord = m; } - /** - * @param recs list of sheet records (possibly contains records for other parts of the Excel file) - * @param startIx index of first row/cell record for current sheet - * @param endIx one past index of last row/cell record for current sheet. It is important - * that this code does not inadvertently collect SharedFormulaRecords from any other - * sheet (which could happen if endIx is chosen poorly). (see bug 44449) - */ public static SharedValueManager create(SharedFormulaRecord[] sharedFormulaRecords, ArrayRecord[] arrayRecords, TableRecord[] tableRecords) { if (sharedFormulaRecords.length + arrayRecords.length + tableRecords.length < 1) { diff --git a/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java b/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java index 4698c5c31..e9eca9925 100644 --- a/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java +++ b/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java @@ -321,7 +321,7 @@ public final class BorderFormatting { /** * get the color to use for the left border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public int getLeftBorderColor() { return bordLeftLineColor.getValue(field_13_border_styles1); @@ -338,7 +338,7 @@ public final class BorderFormatting { /** * get the color to use for the right border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public int getRightBorderColor() { return bordRightLineColor.getValue(field_13_border_styles1); @@ -355,7 +355,7 @@ public final class BorderFormatting { /** * get the color to use for the top border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public int getTopBorderColor() { return bordTopLineColor.getValue(field_14_border_styles2); @@ -373,7 +373,7 @@ public final class BorderFormatting { /** * get the color to use for the bottom border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public int getBottomBorderColor() { return bordBottomLineColor.getValue(field_14_border_styles2); @@ -390,7 +390,7 @@ public final class BorderFormatting { /** * get the color to use for the diagonal border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public int getDiagonalBorderColor() { return bordDiagLineColor.getValue(field_14_border_styles2); diff --git a/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java b/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java index 019644c2d..5769e88c3 100644 --- a/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java +++ b/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java @@ -89,7 +89,7 @@ public final class CellRangeUtil * Do all possible cell merges between cells of the list so that:
*
  • if a cell range is completely inside of another cell range, it gets removed from the list *
  • if two cells have a shared border, merge them into one bigger cell range - * @param cellRangeList + * @param cellRanges * @return updated List of cell ranges */ public static CellRangeAddress[] mergeCellRanges(CellRangeAddress[] cellRanges) { diff --git a/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java b/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java index e932beb9a..d8da21095 100644 --- a/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java +++ b/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java @@ -188,8 +188,8 @@ public final class FontFormatting /** * set the font to be italics or not * - * @param italics - whether the font is italics or not - * @see #setAttributes(short) + * @param italic - whether the font is italics or not + * @see #setFontOption(boolean, org.apache.poi.util.BitField) */ public void setItalic(boolean italic) @@ -201,7 +201,7 @@ public final class FontFormatting * get whether the font is to be italics or not * * @return italics - whether the font is italics or not - * @see #getAttributes() + * @see #getFontOption(org.apache.poi.util.BitField) */ public boolean isItalic() @@ -244,7 +244,7 @@ public final class FontFormatting * get whether the font is to be stricken out or not * * @return strike - whether the font is stricken out or not - * @see #getAttributes() + * @see #getFontOption(org.apache.poi.util.BitField) */ public boolean isStruckout() diff --git a/src/java/org/apache/poi/hssf/record/formula/Ptg.java b/src/java/org/apache/poi/hssf/record/formula/Ptg.java index 771cccf58..08f690ce4 100644 --- a/src/java/org/apache/poi/hssf/record/formula/Ptg.java +++ b/src/java/org/apache/poi/hssf/record/formula/Ptg.java @@ -260,7 +260,7 @@ public abstract class Ptg implements Cloneable { public abstract int getSize(); /** - * @return the encoded length of this Ptg, not including the initial Ptg type identifier byte. + * //@return the encoded length of this Ptg, not including the initial Ptg type identifier byte. */ // public abstract int getDataSize(); diff --git a/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java b/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java index 09be70477..675aad438 100755 --- a/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java +++ b/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java @@ -234,7 +234,7 @@ public final class OperandResolver { * "5**2" -> 500
    * "250%" -> 2.5
    * - * @param text + * @param pText * @return null if the specified text cannot be parsed as a number */ public static Double parseDouble(String pText) { diff --git a/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java b/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java index df7db7ad3..be269d93d 100644 --- a/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java +++ b/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java @@ -90,7 +90,7 @@ public abstract class TextFunction implements Function { * An implementation of the TRIM function: * Removes leading and trailing spaces from value if evaluated operand * value is string. - * @author Manda Wilson < wilson at c bio dot msk cc dot org > + * Author: Manda Wilson < wilson at c bio dot msk cc dot org > */ public static final Function TRIM = new SingleArgTextFunc() { protected ValueEval evaluate(String arg) { @@ -106,7 +106,7 @@ public abstract class TextFunction implements Function { * Syntax:
    MID(text, start_num, * num_chars)
    * - * @author Manda Wilson < wilson at c bio dot msk cc dot org > + * Author: Manda Wilson < wilson at c bio dot msk cc dot org > */ public static final Function MID = new TextFunction() { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java index 6f327b21c..fd51b4385 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java @@ -216,7 +216,6 @@ public class HSSFCell implements Cell { /** * Returns the Workbook that this Cell is bound to - * @return */ protected Workbook getBoundWorkbook() { return book.getWorkbook(); @@ -1085,7 +1084,7 @@ public class HSSFCell implements Cell { /** * Assign a hypelrink to this cell * - * @param link hypelrink associated with this cell + * @param hyperlink hypelrink associated with this cell */ public void setHyperlink(Hyperlink hyperlink){ HSSFHyperlink link = (HSSFHyperlink)hyperlink; diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java index 5baf8219c..a2dbd4d91 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java @@ -437,28 +437,6 @@ public class HSSFCellStyle implements CellStyle return format.getAlignment(); } - /** - * get whether this cell is to be part of a merged block of cells - * - * @returns merged or not - */ - -// public boolean getMergeCells() -// { -// return format.getMergeCells(); -// } - - /** - * set whether this cell is to be part of a merged block of cells - * - * @param merge merged or not - */ - -// public void setMergeCells(boolean merge) -// { -// format.setMergeCells(merge); -// } - /** * set whether the text should be wrapped * @param wrapped wrap text or not @@ -767,7 +745,7 @@ public class HSSFCellStyle implements CellStyle /** * get the color to use for the left border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public short getLeftBorderColor() { @@ -786,7 +764,7 @@ public class HSSFCellStyle implements CellStyle /** * get the color to use for the left border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public short getRightBorderColor() { @@ -805,7 +783,7 @@ public class HSSFCellStyle implements CellStyle /** * get the color to use for the top border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public short getTopBorderColor() { @@ -824,7 +802,7 @@ public class HSSFCellStyle implements CellStyle /** * get the color to use for the left border * @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short) - * @param color The index of the color definition + * @return The index of the color definition */ public short getBottomBorderColor() { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java index 3029515f4..1d843c684 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java @@ -43,7 +43,7 @@ import org.apache.poi.ss.util.Region; *
    • * * - * Use {@link HSSFSheet#getConditionalFormattingAt(int)} to get access to an instance of this class. + * Use {@link org.apache.poi.hssf.usermodel.HSSFSheet#getSheetConditionalFormatting()} to get access to an instance of this class. *

    * To create a new Conditional Formatting set use the following approach: * diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java b/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java index 0591158b6..0dfcbbfa6 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java @@ -138,7 +138,7 @@ public final class HSSFDataValidation { } /** - * @param show true if an prompt box should be displayed , false otherwise + * @return true if an prompt box should be displayed , false otherwise */ public boolean getShowPromptBox() { return _showPromptBox; diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java index 774bc1ea4..f55fe64b5 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java @@ -102,7 +102,6 @@ public final class HSSFFontFormatting } /** - * @return * @see org.apache.poi.hssf.record.cf.FontFormatting#getRawRecord() */ protected byte[] getRawRecord() @@ -228,7 +227,7 @@ public final class HSSFFontFormatting * set font style options. * * @param italic - if true, set posture style to italic, otherwise to normal - * @param bold- if true, set font weight to bold, otherwise to normal + * @param bold if true, set font weight to bold, otherwise to normal */ public void setFontStyle(boolean italic, boolean bold) @@ -302,7 +301,7 @@ public final class HSSFFontFormatting /** * @param height - * @see org.apache.poi.hssf.record.cf.FontFormatting#setFontHeight(short) + * @see org.apache.poi.hssf.record.cf.FontFormatting#setFontHeight(int) */ public void setFontHeight(int height) { @@ -369,7 +368,7 @@ public final class HSSFFontFormatting /** * set the type of underlining type for the font * - * @param u super or subscript option + * @param underlineType super or subscript option * * @see #U_NONE * @see #U_SINGLE diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java index ef8300d09..0ca8d5723 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java @@ -33,7 +33,7 @@ import org.apache.poi.ss.usermodel.CellValue; * Evaluates formula cells.

    * * For performance reasons, this class keeps a cache of all previously calculated intermediate - * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between + * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between * calls to evaluate~ methods on this class. * * @author Amol S. Deshmukh < amolweb at ya hoo dot com > @@ -156,7 +156,7 @@ public class HSSFFormulaEvaluator /* almost implements FormulaEvaluator */ { * int evaluatedCellType = evaluator.evaluateFormulaCell(cell); * * Be aware that your cell will hold both the formula, and the result. If you want the cell - * replaced with the result of the formula, use {@link #evaluateInCell(HSSFCell)} + * replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)} * @param cell The cell to evaluate * @return -1 for non-formula cells, or the type of the formula result */ @@ -183,7 +183,7 @@ public class HSSFFormulaEvaluator /* almost implements FormulaEvaluator */ { * * Be aware that your cell value will be changed to hold the * result of the formula. If you simply want the formula - * value computed for you, use {@link #evaluateFormulaCell(HSSFCell)} + * value computed for you, use {@link #evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)}} * @param cell */ public HSSFCell evaluateInCell(Cell cell) { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java index 1ec1dfa9c..f0d31aad2 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java @@ -82,7 +82,6 @@ public class HSSFPatternFormatting } /** - * @return * @see org.apache.poi.hssf.record.cf.PatternFormatting#getFillBackgroundColor() */ public short getFillBackgroundColor() @@ -91,7 +90,6 @@ public class HSSFPatternFormatting } /** - * @return * @see org.apache.poi.hssf.record.cf.PatternFormatting#getFillForegroundColor() */ public short getFillForegroundColor() @@ -100,7 +98,6 @@ public class HSSFPatternFormatting } /** - * @return * @see org.apache.poi.hssf.record.cf.PatternFormatting#getFillPattern() */ public short getFillPattern() @@ -110,7 +107,7 @@ public class HSSFPatternFormatting /** * @param bg - * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillBackgroundColor(short) + * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillBackgroundColor(int) */ public void setFillBackgroundColor(short bg) { @@ -123,7 +120,7 @@ public class HSSFPatternFormatting /** * @param fg - * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillForegroundColor(short) + * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillForegroundColor(int) */ public void setFillForegroundColor(short fg) { @@ -136,7 +133,7 @@ public class HSSFPatternFormatting /** * @param fp - * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillPattern(short) + * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillPattern(int) */ public void setFillPattern(short fp) { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java index 3668a5339..0ddccfb0e 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java @@ -317,7 +317,7 @@ public final class HSSFRow implements Comparable, Row { * Get the hssfcell representing a given column (logical cell) * 0-based. If you ask for a cell that is not defined then * you get a null, unless you have set a different - * {@link MissingCellPolicy} on the base workbook. + * {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} on the base workbook. * * @param cellnum 0 based column number * @return HSSFCell representing that column or null if undefined. @@ -560,7 +560,7 @@ public final class HSSFRow implements Comparable, Row { * will not return un-defined (null) cells. * Call getCellNum() on the returned cells to know which cell they are. * As this only ever works on physically defined cells, - * the {@link MissingCellPolicy} has no effect. + * the {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} has no effect. */ public Iterator cellIterator() { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index fd0e0a535..5733bbcf3 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -201,7 +201,7 @@ public class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet * @param rownum row number * @return High level HSSFRow object representing a row in the sheet * @see org.apache.poi.hssf.usermodel.HSSFRow - * @see #removeRow(HSSFRow) + * @see #removeRow(org.apache.poi.ss.usermodel.Row) */ public HSSFRow createRow(int rownum) { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java index b2912bc6e..afaeb8031 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java @@ -45,7 +45,7 @@ public final class HSSFSheetConditionalFormatting { * TODO - formulas containing cell references are currently not parsed properly * * @param comparisonOperation - a constant value from - * {@link HSSFConditionalFormattingRule.ComparisonOperator}:

    + * {@link org.apache.poi.hssf.record.CFRuleRecord.ComparisonOperator}:

    *

      *
    • BETWEEN
      • *
    • NOT_BETWEEN
      • @@ -59,8 +59,8 @@ public final class HSSFSheetConditionalFormatting { *

      * @param formula1 - formula for the valued, compared with the cell * @param formula2 - second formula (only used with - * {@link HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN}) and - * {@link HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN} operations) + * {@link org.apache.poi.hssf.record.CFRuleRecord.ComparisonOperator#BETWEEN}) and + * {@link org.apache.poi.hssf.record.CFRuleRecord.ComparisonOperator#NOT_BETWEEN} operations) */ public HSSFConditionalFormattingRule createConditionalFormattingRule( byte comparisonOperation, diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index 24ef987ee..dea16b39d 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -382,7 +382,7 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm * Sets the policy on what to do when * getting missing or blank cells from a row. * This will then apply to all calls to - * {@link HSSFRow.getCell()}. See + * {@link HSSFRow#getCell(int)}}. See * {@link MissingCellPolicy}. * Note that this has no effect on any * iterators, only on when fetching Cells diff --git a/src/java/org/apache/poi/ss/formula/EvaluationCell.java b/src/java/org/apache/poi/ss/formula/EvaluationCell.java index c15754b92..b1f467c5c 100644 --- a/src/java/org/apache/poi/ss/formula/EvaluationCell.java +++ b/src/java/org/apache/poi/ss/formula/EvaluationCell.java @@ -21,7 +21,7 @@ package org.apache.poi.ss.formula; * Abstracts a cell for the purpose of formula evaluation. This interface represents both formula * and non-formula cells.
      * - * Implementors of this class must implement {@link #hashCode()} and {@link #equals(Object)} + * Implementors of this class must implement {@link Object#hashCode()} and {@link Object#equals(Object)} * to provide an identity relationship based on the underlying HSSF or XSSF cell

      * * For POI internal use only diff --git a/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java b/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java index 09262a132..0a4451f65 100644 --- a/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java +++ b/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java @@ -18,7 +18,7 @@ package org.apache.poi.ss.formula; /** - * Should be implemented by any {@link Ptg} subclass that needs has an extern sheet index
      + * Should be implemented by any {@link org.apache.poi.hssf.record.formula.Ptg} subclass that needs has an extern sheet index
      * * For POI internal use only * diff --git a/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java b/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java index b7ccfaf0e..3dc2c525d 100644 --- a/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java +++ b/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java @@ -18,7 +18,7 @@ package org.apache.poi.ss.formula; /** - * Should be implemented by any {@link Ptg} subclass that needs a workbook to render its formula. + * Should be implemented by any {@link org.apache.poi.hssf.record.formula.Ptg} subclass that needs a workbook to render its formula. *
      * * For POI internal use only diff --git a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java index ef5975d3e..d3955f879 100644 --- a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java +++ b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java @@ -68,7 +68,7 @@ import org.apache.poi.ss.usermodel.Cell; * Evaluates formula cells.

      * * For performance reasons, this class keeps a cache of all previously calculated intermediate - * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between + * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between * calls to evaluate~ methods on this class.
      * * For POI internal use only diff --git a/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java b/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java index 15711195b..e60104bd3 100644 --- a/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java +++ b/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java @@ -17,20 +17,11 @@ package org.apache.poi.ss.usermodel; -import org.apache.poi.hssf.record.formula.eval.BlankEval; -import org.apache.poi.hssf.record.formula.eval.BoolEval; -import org.apache.poi.hssf.record.formula.eval.ErrorEval; -import org.apache.poi.hssf.record.formula.eval.NumberEval; -import org.apache.poi.hssf.record.formula.eval.StringEval; -import org.apache.poi.hssf.record.formula.eval.ValueEval; -import org.apache.poi.hssf.usermodel.HSSFSheet; - - /** * Evaluates formula cells.

      * * For performance reasons, this class keeps a cache of all previously calculated intermediate - * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between + * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between * calls to evaluate~ methods on this class. * * @author Amol S. Deshmukh < amolweb at ya hoo dot com > diff --git a/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java b/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java index d862125ca..41c0e9ea3 100644 --- a/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java +++ b/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java @@ -17,8 +17,8 @@ package org.apache.poi.ss.usermodel; /** - * Common interface for {@link Header} and - * {@link Footer}. + * Common interface for {@link org.apache.poi.ss.usermodel.Header} and + * {@link org.apache.poi.ss.usermodel.Footer}. */ public interface HeaderFooter { /** diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java index f804571c0..b26780d85 100644 --- a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java +++ b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java @@ -101,28 +101,28 @@ public abstract class CellRangeAddressBase { } /** - * @param _firstCol column number for the upper left hand corner + * @param firstCol column number for the upper left hand corner */ public final void setFirstColumn(int firstCol) { _firstCol = firstCol; } /** - * @param rowFrom row number for the upper left hand corner + * @param firstRow row number for the upper left hand corner */ public final void setFirstRow(int firstRow) { _firstRow = firstRow; } /** - * @param colTo column number for the lower right hand corner + * @param lastCol column number for the lower right hand corner */ public final void setLastColumn(int lastCol) { _lastCol = lastCol; } /** - * @param rowTo row number for the lower right hand corner + * @param lastRow row number for the lower right hand corner */ public final void setLastRow(int lastRow) { _lastRow = lastRow; diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressList.java b/src/java/org/apache/poi/ss/util/CellRangeAddressList.java index f5dd8ab7c..f0444e5e2 100644 --- a/src/java/org/apache/poi/ss/util/CellRangeAddressList.java +++ b/src/java/org/apache/poi/ss/util/CellRangeAddressList.java @@ -84,7 +84,6 @@ public class CellRangeAddressList { * @param firstCol - the upper left hand corner's col * @param lastRow - the lower right hand corner's row * @param lastCol - the lower right hand corner's col - * @return the index of this ADDR structure */ public void addCellRangeAddress(int firstRow, int firstCol, int lastRow, int lastCol) { CellRangeAddress region = new CellRangeAddress(firstRow, lastRow, firstCol, lastCol); diff --git a/src/java/org/apache/poi/ss/util/Region.java b/src/java/org/apache/poi/ss/util/Region.java index 1ee64c5d0..aee3eef0a 100644 --- a/src/java/org/apache/poi/ss/util/Region.java +++ b/src/java/org/apache/poi/ss/util/Region.java @@ -209,7 +209,7 @@ public class Region implements Comparable { /** * Convert a List of CellRange objects to an array of regions * - * @param List of CellRange objects + * @param cellRanges list of CellRange objects * @return regions */ public static Region[] convertCellRangesToRegions(CellRangeAddress[] cellRanges) { diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java index 263f45e1e..287c36b19 100644 --- a/src/java/org/apache/poi/util/StringUtil.java +++ b/src/java/org/apache/poi/util/StringUtil.java @@ -25,7 +25,7 @@ import org.apache.poi.hssf.record.RecordInputStream; /** * Title: String Utility Description: Collection of string handling utilities

      * - * Note - none of the methods in this class deals with {@link ContinueRecord}s. For such + * Note - none of the methods in this class deals with {@link org.apache.poi.hssf.record.ContinueRecord}s. For such * functionality, consider using {@link RecordInputStream } * * diff --git a/src/ooxml/java/org/apache/poi/util/PackageHelper.java b/src/ooxml/java/org/apache/poi/util/PackageHelper.java index 4471a6046..258e5b8d1 100755 --- a/src/ooxml/java/org/apache/poi/util/PackageHelper.java +++ b/src/ooxml/java/org/apache/poi/util/PackageHelper.java @@ -84,9 +84,7 @@ public class PackageHelper { } /** - * - * @return - * @throws IOException + * Creates an empty file in the default temporary-file directory, */ public static File createTempFile() throws IOException { File file = File.createTempFile("poi-ooxml-", ".tmp"); diff --git a/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java b/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java index fd37e79fd..d16cf9a1b 100644 --- a/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java +++ b/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java @@ -36,7 +36,7 @@ public interface XSSFChildContainingModel extends XSSFModel { * appropriate model or usermodel thing can be * created for it. * @param childPart The PackagePart of the child - * @param childId the ID of the relationship the child comes from + * @param childRelId the ID of the relationship the child comes from */ public void generateChild(PackagePart childPart, String childRelId); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java index f738b8774..edbae8376 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java @@ -86,8 +86,8 @@ public final class XSSFCell implements Cell { /** * Construct a XSSFCell. * - * @param row the xml bean containing information about the cell. * @param row the parent row. + * @param cell the xml bean containing information about the cell. */ protected XSSFCell(XSSFRow row, CTCell cell) { this.cell = cell; diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java index 74baa5f2e..8a6ca929c 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java @@ -120,13 +120,13 @@ public class XSSFCellStyle implements CellStyle { * Get the type of horizontal alignment for the cell * * @return short - the type of alignment - * @see #ALIGN_GENERAL - * @see #ALIGN_LEFT - * @see #ALIGN_CENTER - * @see #ALIGN_RIGHT - * @see #ALIGN_FILL - * @see #ALIGN_JUSTIFY - * @see #ALIGN_CENTER_SELECTION + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_GENERAL + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_LEFT + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_RIGHT + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_FILL + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_JUSTIFY + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER_SELECTION */ public short getAlignment() { return (short)(getAlignmentEnum().ordinal()); @@ -136,6 +136,7 @@ public class XSSFCellStyle implements CellStyle { * Get the type of horizontal alignment for the cell * * @return HorizontalAlignment - the type of alignment + * @see org.apache.poi.ss.usermodel.HorizontalAlignment */ public HorizontalAlignment getAlignmentEnum() { CTCellAlignment align = cellXf.getAlignment(); @@ -150,20 +151,20 @@ public class XSSFCellStyle implements CellStyle { * Get the type of border to use for the bottom border of the cell * * @return short - border type - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public short getBorderBottom() { if(!cellXf.getApplyBorder()) return BORDER_NONE; @@ -188,21 +189,21 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of border to use for the left border of the cell * - * @return short - border type, default value is {@link #BORDER_NONE} - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @return short - border type, default value is {@link org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE} + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public short getBorderLeft() { if(!cellXf.getApplyBorder()) return BORDER_NONE; @@ -216,7 +217,7 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of border to use for the left border of the cell * - * @return border type, default value is {@link BorderStyle.NONE} + * @return border type, default value is {@link org.apache.poi.ss.usermodel.BorderStyle#NONE} */ public BorderStyle getBorderLeftEnum() { int style = getBorderLeft(); @@ -226,21 +227,21 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of border to use for the right border of the cell * - * @return short - border type, default value is {@link #BORDER_NONE} - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @return short - border type, default value is {@link org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE} + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public short getBorderRight() { if(!cellXf.getApplyBorder()) return BORDER_NONE; @@ -254,7 +255,7 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of border to use for the right border of the cell * - * @return border type, default value is {@link BorderStyle.NONE} + * @return border type, default value is {@link org.apache.poi.ss.usermodel.BorderStyle#NONE} */ public BorderStyle getBorderRightEnum() { int style = getBorderRight(); @@ -264,21 +265,21 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of border to use for the top border of the cell * - * @return short - border type, default value is {@link #BORDER_NONE} - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @return short - border type, default value is {@link org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE} + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle #BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public short getBorderTop() { if(!cellXf.getApplyBorder()) return BORDER_NONE; @@ -292,7 +293,7 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of border to use for the top border of the cell * - * @return border type, default value is {@link BorderStyle.NONE} + * @return border type, default value is {@link org.apache.poi.ss.usermodel.BorderStyle#NONE} */ public BorderStyle getBorderTopEnum() { int style = getBorderTop(); @@ -303,8 +304,8 @@ public class XSSFCellStyle implements CellStyle { * Get the color to use for the bottom border *
      * Color is optional. When missing, IndexedColors.AUTOMATIC is implied. - * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors.AUTOMATIC} - * @see IndexedColors + * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#AUTOMATIC} + * @see org.apache.poi.ss.usermodel.IndexedColors */ public short getBottomBorderColor() { XSSFColor clr = getBottomBorderXSSFColor(); @@ -350,8 +351,8 @@ public class XSSFCellStyle implements CellStyle { * Note - many cells are actually filled with a foreground * fill, not a background fill - see {@link #getFillForegroundColor()} *

      - * @return fill color, default value is {@link IndexedColors.AUTOMATIC} - * @see IndexedColors + * @return fill color, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#AUTOMATIC} + * @see org.apache.poi.ss.usermodel.IndexedColors */ public short getFillBackgroundColor() { XSSFColor clr = getFillBackgroundXSSFColor(); @@ -383,7 +384,7 @@ public class XSSFCellStyle implements CellStyle { * background color ({@link #getFillBackgroundColor()}) *

      * @see IndexedColors - * @return fill color, default value is {@link IndexedColors.AUTOMATIC} + * @return fill color, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#AUTOMATIC} */ public short getFillForegroundColor() { XSSFColor clr = getFillForegroundXSSFColor(); @@ -406,25 +407,25 @@ public class XSSFCellStyle implements CellStyle { /** * Get the fill pattern - * @return fill pattern, default value is {@link #NO_FILL} + * @return fill pattern, default value is {@link org.apache.poi.ss.usermodel.CellStyle#NO_FILL} * - * @see #NO_FILL - * @see #SOLID_FOREGROUND - * @see #FINE_DOTS - * @see #ALT_BARS - * @see #SPARSE_DOTS - * @see #THICK_HORZ_BANDS - * @see #THICK_VERT_BANDS - * @see #THICK_BACKWARD_DIAG - * @see #THICK_FORWARD_DIAG - * @see #BIG_SPOTS - * @see #BRICKS - * @see #THIN_HORZ_BANDS - * @see #THIN_VERT_BANDS - * @see #THIN_BACKWARD_DIAG - * @see #THIN_FORWARD_DIAG - * @see #SQUARES - * @see #DIAMONDS + * @see org.apache.poi.ss.usermodel.CellStyle#NO_FILL + * @see org.apache.poi.ss.usermodel.CellStyle#SOLID_FOREGROUND + * @see org.apache.poi.ss.usermodel.CellStyle#FINE_DOTS + * @see org.apache.poi.ss.usermodel.CellStyle#ALT_BARS + * @see org.apache.poi.ss.usermodel.CellStyle#SPARSE_DOTS + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_HORZ_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_VERT_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_BACKWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_FORWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#BIG_SPOTS + * @see org.apache.poi.ss.usermodel.CellStyle#BRICKS + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_HORZ_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_VERT_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_BACKWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_FORWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#SQUARES + * @see org.apache.poi.ss.usermodel.CellStyle#DIAMONDS */ public short getFillPattern() { if(!cellXf.getApplyFill()) return 0; @@ -440,7 +441,7 @@ public class XSSFCellStyle implements CellStyle { /** * Get the fill pattern * - * @return the fill pattern, default value is {@link FillPatternType.NO_FILL} + * @return the fill pattern, default value is {@link org.apache.poi.ss.usermodel.FillPatternType#NO_FILL} */ public FillPatternType getFillPatternEnum() { int style = getFillPattern(); @@ -499,8 +500,8 @@ public class XSSFCellStyle implements CellStyle { /** * Get the color to use for the left border * - * @return the index of the color definition, default value is {@link IndexedColors.BLACK} - * @see IndexedColors + * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#BLACK} + * @see org.apache.poi.ss.usermodel.IndexedColors */ public short getLeftBorderColor() { XSSFColor clr = getLeftBorderXSSFColor(); @@ -511,7 +512,7 @@ public class XSSFCellStyle implements CellStyle { * Get the color to use for the left border * * @return the index of the color definition or null if not set - * @see IndexedColors + * @see org.apache.poi.ss.usermodel.IndexedColors */ public XSSFColor getLeftBorderXSSFColor() { if(!cellXf.getApplyBorder()) return null; @@ -534,8 +535,8 @@ public class XSSFCellStyle implements CellStyle { /** * Get the color to use for the right border * - * @return the index of the color definition, default value is {@link IndexedColors.BLACK} - * @see IndexedColors + * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#BLACK} + * @see org.apache.poi.ss.usermodel.IndexedColors */ public short getRightBorderColor() { XSSFColor clr = getRightBorderXSSFColor(); @@ -577,8 +578,8 @@ public class XSSFCellStyle implements CellStyle { /** * Get the color to use for the top border * - * @return the index of the color definition, default value is {@link IndexedColors.BLACK} - * @see IndexedColors + * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#BLACK} + * @see org.apache.poi.ss.usermodel.IndexedColors */ public short getTopBorderColor() { XSSFColor clr = getTopBorderXSSFColor(); @@ -602,11 +603,11 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of vertical alignment for the cell * - * @return align the type of alignment, default value is {@link #VERTICAL_BOTTOM} - * @see #VERTICAL_TOP - * @see #VERTICAL_CENTER - * @see #VERTICAL_BOTTOM - * @see #VERTICAL_JUSTIFY + * @return align the type of alignment, default value is {@link org.apache.poi.ss.usermodel.CellStyle#VERTICAL_BOTTOM} + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_TOP + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_CENTER + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_BOTTOM + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_JUSTIFY */ public short getVerticalAlignment() { return (short) (getVerticalAlignmentEnum().ordinal()); @@ -615,8 +616,8 @@ public class XSSFCellStyle implements CellStyle { /** * Get the type of vertical alignment for the cell * - * @return the type of alignment, default value is {@link VerticalAlignment.BOTTOM} - * @see VerticalAlignment + * @return the type of alignment, default value is {@link org.apache.poi.ss.usermodel.VerticalAlignment#BOTTOM} + * @see org.apache.poi.ss.usermodel.VerticalAlignment */ public VerticalAlignment getVerticalAlignmentEnum() { CTCellAlignment align = cellXf.getAlignment(); @@ -641,13 +642,13 @@ public class XSSFCellStyle implements CellStyle { * Set the type of horizontal alignment for the cell * * @param align - the type of alignment - * @see #ALIGN_GENERAL - * @see #ALIGN_LEFT - * @see #ALIGN_CENTER - * @see #ALIGN_RIGHT - * @see #ALIGN_FILL - * @see #ALIGN_JUSTIFY - * @see #ALIGN_CENTER_SELECTION + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_GENERAL + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_LEFT + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_RIGHT + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_FILL + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_JUSTIFY + * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER_SELECTION */ public void setAlignment(short align) { getCellAlignment().setHorizontal(HorizontalAlignment.values()[align]); @@ -667,20 +668,20 @@ public class XSSFCellStyle implements CellStyle { * Set the type of border to use for the bottom border of the cell * * @param border the type of border to use - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public void setBorderBottom(short border) { CTBorder ct = getCTBorder(); @@ -698,7 +699,7 @@ public class XSSFCellStyle implements CellStyle { * Set the type of border to use for the bottom border of the cell * * @param border - type of border to use - * @see BorderStyle + * @see org.apache.poi.ss.usermodel.BorderStyle */ public void setBorderBottom(BorderStyle border) { setBorderBottom((short)border.ordinal()); @@ -707,20 +708,20 @@ public class XSSFCellStyle implements CellStyle { /** * Set the type of border to use for the left border of the cell * @param border the type of border to use - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public void setBorderLeft(short border) { CTBorder ct = getCTBorder(); @@ -747,20 +748,20 @@ public class XSSFCellStyle implements CellStyle { * Set the type of border to use for the right border of the cell * * @param border the type of border to use - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public void setBorderRight(short border) { CTBorder ct = getCTBorder(); @@ -787,20 +788,20 @@ public class XSSFCellStyle implements CellStyle { * Set the type of border to use for the top border of the cell * * @param border the type of border to use - * @see #BORDER_NONE - * @see #BORDER_THIN - * @see #BORDER_MEDIUM - * @see #BORDER_DASHED - * @see #BORDER_DOTTED - * @see #BORDER_THICK - * @see #BORDER_DOUBLE - * @see #BORDER_HAIR - * @see #BORDER_MEDIUM_DASHED - * @see #BORDER_DASH_DOT - * @see #BORDER_MEDIUM_DASH_DOT - * @see #BORDER_DASH_DOT_DOT - * @see #BORDER_MEDIUM_DASH_DOT_DOT - * @see #BORDER_SLANTED_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT + * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT */ public void setBorderTop(short border) { CTBorder ct = getCTBorder(); @@ -826,7 +827,7 @@ public class XSSFCellStyle implements CellStyle { /** * Set the color to use for the bottom border * @param color the index of the color definition - * @see IndexedColors + * @see org.apache.poi.ss.usermodel.IndexedColors */ public void setBottomBorderColor(short color) { XSSFColor clr = new XSSFColor(); @@ -928,7 +929,7 @@ public class XSSFCellStyle implements CellStyle { * for the color to be shown in the cell. * * @param bg - the color to use - * @see IndexedColors + * @see org.apache.poi.ss.usermodel.IndexedColors */ public void setFillBackgroundColor(short bg) { XSSFColor clr = new XSSFColor(); @@ -965,7 +966,7 @@ public class XSSFCellStyle implements CellStyle { *
      * Note: Ensure Foreground color is set prior to background color. * @param fg the color to use - * @see IndexedColors + * @see org.apache.poi.ss.usermodel.IndexedColors */ public void setFillForegroundColor(short fg) { XSSFColor clr = new XSSFColor(); @@ -1010,26 +1011,26 @@ public class XSSFCellStyle implements CellStyle { * For solid cell fills (no pattern), foregorund color is used. * For cell fills with patterns specified, then the cell fill color is specified by the background color. * - * @see #NO_FILL - * @see #SOLID_FOREGROUND - * @see #FINE_DOTS - * @see #ALT_BARS - * @see #SPARSE_DOTS - * @see #THICK_HORZ_BANDS - * @see #THICK_VERT_BANDS - * @see #THICK_BACKWARD_DIAG - * @see #THICK_FORWARD_DIAG - * @see #BIG_SPOTS - * @see #BRICKS - * @see #THIN_HORZ_BANDS - * @see #THIN_VERT_BANDS - * @see #THIN_BACKWARD_DIAG - * @see #THIN_FORWARD_DIAG - * @see #SQUARES - * @see #DIAMONDS + * @see org.apache.poi.ss.usermodel.CellStyle#NO_FILL + * @see org.apache.poi.ss.usermodel.CellStyle#SOLID_FOREGROUND + * @see org.apache.poi.ss.usermodel.CellStyle#FINE_DOTS + * @see org.apache.poi.ss.usermodel.CellStyle#ALT_BARS + * @see org.apache.poi.ss.usermodel.CellStyle#SPARSE_DOTS + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_HORZ_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_VERT_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_BACKWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#THICK_FORWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#BIG_SPOTS + * @see org.apache.poi.ss.usermodel.CellStyle#BRICKS + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_HORZ_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_VERT_BANDS + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_BACKWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#THIN_FORWARD_DIAG + * @see org.apache.poi.ss.usermodel.CellStyle#SQUARES + * @see org.apache.poi.ss.usermodel.CellStyle#DIAMONDS * @see #setFillBackgroundColor(short) * @see #setFillForegroundColor(short) - * @param fp fill pattern (set to {@link #SOLID_FOREGROUND} to fill w/foreground color) + * @param fp fill pattern (set to {@link org.apache.poi.ss.usermodel.CellStyle#SOLID_FOREGROUND} to fill w/foreground color) */ public void setFillPattern(short fp) { CTFill ct = getCTFill(); @@ -1050,7 +1051,7 @@ public class XSSFCellStyle implements CellStyle { * @param ptrn the fill pattern to use * @see #setFillBackgroundColor(short) * @see #setFillForegroundColor(short) - * @see FillPatternType + * @see org.apache.poi.ss.usermodel.FillPatternType */ public void setFillPattern(FillPatternType ptrn) { setFillPattern((short)ptrn.ordinal()); @@ -1095,7 +1096,7 @@ public class XSSFCellStyle implements CellStyle { * Set the color to use for the left border as a indexed color value * * @param color the index of the color definition - * @see IndexedColors + * @see org.apache.poi.ss.usermodel.IndexedColors */ public void setLeftBorderColor(short color) { XSSFColor clr = new XSSFColor(); @@ -1135,7 +1136,7 @@ public class XSSFCellStyle implements CellStyle { * Set the color to use for the right border * * @param color the index of the color definition - * @see IndexedColors + * @see org.apache.poi.ss.usermodel.IndexedColors */ public void setRightBorderColor(short color) { XSSFColor clr = new XSSFColor(); @@ -1216,11 +1217,11 @@ public class XSSFCellStyle implements CellStyle { * Set the type of vertical alignment for the cell * * @param align - align the type of alignment - * @see #VERTICAL_TOP - * @see #VERTICAL_CENTER - * @see #VERTICAL_BOTTOM - * @see #VERTICAL_JUSTIFY - * @see VerticalAlignment + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_TOP + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_CENTER + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_BOTTOM + * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_JUSTIFY + * @see org.apache.poi.ss.usermodel.VerticalAlignment */ public void setVerticalAlignment(short align) { getCellAlignment().setVertical(VerticalAlignment.values()[align]); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java index d24b26451..c4af9bdaf 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java @@ -38,7 +38,7 @@ public class XSSFFont implements Font { public static final short DEFAULT_FONT_SIZE = 11; /** * Default font color is black - * @see IndexedColors.BLACK + * @see org.apache.poi.ss.usermodel.IndexedColors#BLACK */ public static final short DEFAULT_FONT_COLOR = IndexedColors.BLACK.getIndex(); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.java index 19f75aab4..cd20997c8 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.java @@ -1,246 +1,244 @@ -/* ==================================================================== - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -==================================================================== */ - -package org.apache.poi.xssf.usermodel; - -import java.util.Iterator; - -import org.apache.poi.hssf.record.formula.eval.BoolEval; -import org.apache.poi.hssf.record.formula.eval.ErrorEval; -import org.apache.poi.hssf.record.formula.eval.NumberEval; -import org.apache.poi.hssf.record.formula.eval.StringEval; -import org.apache.poi.hssf.record.formula.eval.ValueEval; -import org.apache.poi.hssf.usermodel.HSSFCell; -import org.apache.poi.ss.formula.WorkbookEvaluator; -import org.apache.poi.ss.usermodel.Cell; -import org.apache.poi.ss.usermodel.CellValue; -import org.apache.poi.ss.usermodel.FormulaEvaluator; -import org.apache.poi.ss.usermodel.Row; -import org.apache.poi.ss.usermodel.Sheet; - -/** - * Evaluates formula cells.

      - * - * For performance reasons, this class keeps a cache of all previously calculated intermediate - * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between - * calls to evaluate~ methods on this class. - * - * @author Amol S. Deshmukh < amolweb at ya hoo dot com > - * @author Josh Micich - */ -public class XSSFFormulaEvaluator implements FormulaEvaluator { - - private WorkbookEvaluator _bookEvaluator; - - public XSSFFormulaEvaluator(XSSFWorkbook workbook) { - _bookEvaluator = new WorkbookEvaluator(XSSFEvaluationWorkbook.create(workbook)); - } - - /** - * Should be called whenever there are major changes (e.g. moving sheets) to input cells - * in the evaluated workbook. - * Failure to call this method after changing cell values will cause incorrect behaviour - * of the evaluate~ methods of this class - */ - public void clearAllCachedResultValues() { - _bookEvaluator.clearAllCachedResultValues(); - } - public void notifySetFormula(Cell cell) { - _bookEvaluator.notifyUpdateCell(new XSSFEvaluationCell((XSSFCell)cell)); - } - public void notifyDeleteCell(Cell cell) { - _bookEvaluator.notifyDeleteCell(new XSSFEvaluationCell((XSSFCell)cell)); - } - - /** - * If cell contains a formula, the formula is evaluated and returned, - * else the CellValue simply copies the appropriate cell value from - * the cell and also its cell type. This method should be preferred over - * evaluateInCell() when the call should not modify the contents of the - * original cell. - * @param cell - */ - public CellValue evaluate(Cell cell) { - if (cell == null) { - return null; - } - - switch (cell.getCellType()) { - case XSSFCell.CELL_TYPE_BOOLEAN: - return CellValue.valueOf(cell.getBooleanCellValue()); - case XSSFCell.CELL_TYPE_ERROR: - return CellValue.getError(cell.getErrorCellValue()); - case XSSFCell.CELL_TYPE_FORMULA: - return evaluateFormulaCellValue(cell); - case XSSFCell.CELL_TYPE_NUMERIC: - return new CellValue(cell.getNumericCellValue()); - case XSSFCell.CELL_TYPE_STRING: - return new CellValue(cell.getRichStringCellValue().getString()); - } - throw new IllegalStateException("Bad cell type (" + cell.getCellType() + ")"); - } - - - /** - * If cell contains formula, it evaluates the formula, - * and saves the result of the formula. The cell - * remains as a formula cell. - * Else if cell does not contain formula, this method leaves - * the cell unchanged. - * Note that the type of the formula result is returned, - * so you know what kind of value is also stored with - * the formula. - * 

      -	 * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
-	 *
      - * Be aware that your cell will hold both the formula, - * and the result. If you want the cell replaced with - * the result of the formula, use {@link #evaluateInCell(HSSFCell)} - * @param cell The cell to evaluate - * @return The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however) - */ - public int evaluateFormulaCell(Cell cell) { - if (cell == null || cell.getCellType() != XSSFCell.CELL_TYPE_FORMULA) { - return -1; - } - CellValue cv = evaluateFormulaCellValue(cell); - // cell remains a formula cell, but the cached value is changed - setCellValue(cell, cv); - return cv.getCellType(); - } - - /** - * If cell contains formula, it evaluates the formula, and - * puts the formula result back into the cell, in place - * of the old formula. - * Else if cell does not contain formula, this method leaves - * the cell unchanged. - * Note that the same instance of HSSFCell is returned to - * allow chained calls like: - * 
      -	 * int evaluatedCellType = evaluator.evaluateInCell(cell).getCellType();
-	 *
      - * Be aware that your cell value will be changed to hold the - * result of the formula. If you simply want the formula - * value computed for you, use {@link #evaluateFormulaCell(HSSFCell)} - * @param cell - */ - public XSSFCell evaluateInCell(Cell cell) { - if (cell == null) { - return null; - } - XSSFCell result = (XSSFCell) cell; - if (cell.getCellType() == XSSFCell.CELL_TYPE_FORMULA) { - CellValue cv = evaluateFormulaCellValue(cell); - setCellType(cell, cv); // cell will no longer be a formula cell - setCellValue(cell, cv); - } - return result; - } - private static void setCellType(Cell cell, CellValue cv) { - int cellType = cv.getCellType(); - switch (cellType) { - case XSSFCell.CELL_TYPE_BOOLEAN: - case XSSFCell.CELL_TYPE_ERROR: - case XSSFCell.CELL_TYPE_NUMERIC: - case XSSFCell.CELL_TYPE_STRING: - cell.setCellType(cellType); - return; - case XSSFCell.CELL_TYPE_BLANK: - // never happens - blanks eventually get translated to zero - case XSSFCell.CELL_TYPE_FORMULA: - // this will never happen, we have already evaluated the formula - } - throw new IllegalStateException("Unexpected cell value type (" + cellType + ")"); - } - - private static void setCellValue(Cell cell, CellValue cv) { - int cellType = cv.getCellType(); - switch (cellType) { - case XSSFCell.CELL_TYPE_BOOLEAN: - cell.setCellValue(cv.getBooleanValue()); - break; - case XSSFCell.CELL_TYPE_ERROR: - cell.setCellErrorValue(cv.getErrorValue()); - break; - case XSSFCell.CELL_TYPE_NUMERIC: - cell.setCellValue(cv.getNumberValue()); - break; - case XSSFCell.CELL_TYPE_STRING: - cell.setCellValue(new XSSFRichTextString(cv.getStringValue())); - break; - case XSSFCell.CELL_TYPE_BLANK: - // never happens - blanks eventually get translated to zero - case XSSFCell.CELL_TYPE_FORMULA: - // this will never happen, we have already evaluated the formula - default: - throw new IllegalStateException("Unexpected cell value type (" + cellType + ")"); - } - } - - /** - * Loops over all cells in all sheets of the supplied - * workbook. - * For cells that contain formulas, their formulas are - * evaluated, and the results are saved. These cells - * remain as formula cells. - * For cells that do not contain formulas, no changes - * are made. - * This is a helpful wrapper around looping over all - * cells, and calling evaluateFormulaCell on each one. - */ - public static void evaluateAllFormulaCells(XSSFWorkbook wb) { - XSSFFormulaEvaluator evaluator = new XSSFFormulaEvaluator(wb); - for(int i=0; i rit = sheet.rowIterator(); rit.hasNext();) { - Row r = rit.next(); - - for (Iterator cit = r.cellIterator(); cit.hasNext();) { - XSSFCell c = (XSSFCell) cit.next(); - if (c.getCellType() == XSSFCell.CELL_TYPE_FORMULA) - evaluator.evaluateFormulaCell(c); - } - } - } - } - - /** - * Returns a CellValue wrapper around the supplied ValueEval instance. - * @param eval - */ - private CellValue evaluateFormulaCellValue(Cell cell) { - ValueEval eval = _bookEvaluator.evaluate(new XSSFEvaluationCell((XSSFCell) cell)); - if (eval instanceof NumberEval) { - NumberEval ne = (NumberEval) eval; - return new CellValue(ne.getNumberValue()); - } - if (eval instanceof BoolEval) { - BoolEval be = (BoolEval) eval; - return CellValue.valueOf(be.getBooleanValue()); - } - if (eval instanceof StringEval) { - StringEval ne = (StringEval) eval; - return new CellValue(ne.getStringValue()); - } - if (eval instanceof ErrorEval) { - return CellValue.getError(((ErrorEval)eval).getErrorCode()); - } - throw new RuntimeException("Unexpected eval class (" + eval.getClass().getName() + ")"); - } -} +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +==================================================================== */ + +package org.apache.poi.xssf.usermodel; + +import java.util.Iterator; + +import org.apache.poi.hssf.record.formula.eval.BoolEval; +import org.apache.poi.hssf.record.formula.eval.ErrorEval; +import org.apache.poi.hssf.record.formula.eval.NumberEval; +import org.apache.poi.hssf.record.formula.eval.StringEval; +import org.apache.poi.hssf.record.formula.eval.ValueEval; +import org.apache.poi.ss.formula.WorkbookEvaluator; +import org.apache.poi.ss.usermodel.Cell; +import org.apache.poi.ss.usermodel.CellValue; +import org.apache.poi.ss.usermodel.FormulaEvaluator; +import org.apache.poi.ss.usermodel.Row; +import org.apache.poi.ss.usermodel.Sheet; + +/** + * Evaluates formula cells.

      + * + * For performance reasons, this class keeps a cache of all previously calculated intermediate + * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between + * calls to evaluate~ methods on this class. + * + * @author Amol S. Deshmukh < amolweb at ya hoo dot com > + * @author Josh Micich + */ +public class XSSFFormulaEvaluator implements FormulaEvaluator { + + private WorkbookEvaluator _bookEvaluator; + + public XSSFFormulaEvaluator(XSSFWorkbook workbook) { + _bookEvaluator = new WorkbookEvaluator(XSSFEvaluationWorkbook.create(workbook)); + } + + /** + * Should be called whenever there are major changes (e.g. moving sheets) to input cells + * in the evaluated workbook. + * Failure to call this method after changing cell values will cause incorrect behaviour + * of the evaluate~ methods of this class + */ + public void clearAllCachedResultValues() { + _bookEvaluator.clearAllCachedResultValues(); + } + public void notifySetFormula(Cell cell) { + _bookEvaluator.notifyUpdateCell(new XSSFEvaluationCell((XSSFCell)cell)); + } + public void notifyDeleteCell(Cell cell) { + _bookEvaluator.notifyDeleteCell(new XSSFEvaluationCell((XSSFCell)cell)); + } + + /** + * If cell contains a formula, the formula is evaluated and returned, + * else the CellValue simply copies the appropriate cell value from + * the cell and also its cell type. This method should be preferred over + * evaluateInCell() when the call should not modify the contents of the + * original cell. + * @param cell + */ + public CellValue evaluate(Cell cell) { + if (cell == null) { + return null; + } + + switch (cell.getCellType()) { + case XSSFCell.CELL_TYPE_BOOLEAN: + return CellValue.valueOf(cell.getBooleanCellValue()); + case XSSFCell.CELL_TYPE_ERROR: + return CellValue.getError(cell.getErrorCellValue()); + case XSSFCell.CELL_TYPE_FORMULA: + return evaluateFormulaCellValue(cell); + case XSSFCell.CELL_TYPE_NUMERIC: + return new CellValue(cell.getNumericCellValue()); + case XSSFCell.CELL_TYPE_STRING: + return new CellValue(cell.getRichStringCellValue().getString()); + } + throw new IllegalStateException("Bad cell type (" + cell.getCellType() + ")"); + } + + + /** + * If cell contains formula, it evaluates the formula, + * and saves the result of the formula. The cell + * remains as a formula cell. + * Else if cell does not contain formula, this method leaves + * the cell unchanged. + * Note that the type of the formula result is returned, + * so you know what kind of value is also stored with + * the formula. + * 

      +	 * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
+	 *
      + * Be aware that your cell will hold both the formula, + * and the result. If you want the cell replaced with + * the result of the formula, use {@link #evaluate(org.apache.poi.ss.usermodel.Cell)} } + * @param cell The cell to evaluate + * @return The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however) + */ + public int evaluateFormulaCell(Cell cell) { + if (cell == null || cell.getCellType() != XSSFCell.CELL_TYPE_FORMULA) { + return -1; + } + CellValue cv = evaluateFormulaCellValue(cell); + // cell remains a formula cell, but the cached value is changed + setCellValue(cell, cv); + return cv.getCellType(); + } + + /** + * If cell contains formula, it evaluates the formula, and + * puts the formula result back into the cell, in place + * of the old formula. + * Else if cell does not contain formula, this method leaves + * the cell unchanged. + * Note that the same instance of HSSFCell is returned to + * allow chained calls like: + * 
      +	 * int evaluatedCellType = evaluator.evaluateInCell(cell).getCellType();
+	 *
      + * Be aware that your cell value will be changed to hold the + * result of the formula. If you simply want the formula + * value computed for you, use {@link #evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)} } + * @param cell + */ + public XSSFCell evaluateInCell(Cell cell) { + if (cell == null) { + return null; + } + XSSFCell result = (XSSFCell) cell; + if (cell.getCellType() == XSSFCell.CELL_TYPE_FORMULA) { + CellValue cv = evaluateFormulaCellValue(cell); + setCellType(cell, cv); // cell will no longer be a formula cell + setCellValue(cell, cv); + } + return result; + } + private static void setCellType(Cell cell, CellValue cv) { + int cellType = cv.getCellType(); + switch (cellType) { + case XSSFCell.CELL_TYPE_BOOLEAN: + case XSSFCell.CELL_TYPE_ERROR: + case XSSFCell.CELL_TYPE_NUMERIC: + case XSSFCell.CELL_TYPE_STRING: + cell.setCellType(cellType); + return; + case XSSFCell.CELL_TYPE_BLANK: + // never happens - blanks eventually get translated to zero + case XSSFCell.CELL_TYPE_FORMULA: + // this will never happen, we have already evaluated the formula + } + throw new IllegalStateException("Unexpected cell value type (" + cellType + ")"); + } + + private static void setCellValue(Cell cell, CellValue cv) { + int cellType = cv.getCellType(); + switch (cellType) { + case XSSFCell.CELL_TYPE_BOOLEAN: + cell.setCellValue(cv.getBooleanValue()); + break; + case XSSFCell.CELL_TYPE_ERROR: + cell.setCellErrorValue(cv.getErrorValue()); + break; + case XSSFCell.CELL_TYPE_NUMERIC: + cell.setCellValue(cv.getNumberValue()); + break; + case XSSFCell.CELL_TYPE_STRING: + cell.setCellValue(new XSSFRichTextString(cv.getStringValue())); + break; + case XSSFCell.CELL_TYPE_BLANK: + // never happens - blanks eventually get translated to zero + case XSSFCell.CELL_TYPE_FORMULA: + // this will never happen, we have already evaluated the formula + default: + throw new IllegalStateException("Unexpected cell value type (" + cellType + ")"); + } + } + + /** + * Loops over all cells in all sheets of the supplied + * workbook. + * For cells that contain formulas, their formulas are + * evaluated, and the results are saved. These cells + * remain as formula cells. + * For cells that do not contain formulas, no changes + * are made. + * This is a helpful wrapper around looping over all + * cells, and calling evaluateFormulaCell on each one. + */ + public static void evaluateAllFormulaCells(XSSFWorkbook wb) { + XSSFFormulaEvaluator evaluator = new XSSFFormulaEvaluator(wb); + for(int i=0; i rit = sheet.rowIterator(); rit.hasNext();) { + Row r = rit.next(); + + for (Iterator cit = r.cellIterator(); cit.hasNext();) { + XSSFCell c = (XSSFCell) cit.next(); + if (c.getCellType() == XSSFCell.CELL_TYPE_FORMULA) + evaluator.evaluateFormulaCell(c); + } + } + } + } + + /** + * Returns a CellValue wrapper around the supplied ValueEval instance. + */ + private CellValue evaluateFormulaCellValue(Cell cell) { + ValueEval eval = _bookEvaluator.evaluate(new XSSFEvaluationCell((XSSFCell) cell)); + if (eval instanceof NumberEval) { + NumberEval ne = (NumberEval) eval; + return new CellValue(ne.getNumberValue()); + } + if (eval instanceof BoolEval) { + BoolEval be = (BoolEval) eval; + return CellValue.valueOf(be.getBooleanValue()); + } + if (eval instanceof StringEval) { + StringEval ne = (StringEval) eval; + return new CellValue(ne.getStringValue()); + } + if (eval instanceof ErrorEval) { + return CellValue.getError(((ErrorEval)eval).getErrorCode()); + } + throw new RuntimeException("Unexpected eval class (" + eval.getClass().getName() + ")"); + } +} diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java index 2e1394b44..f776aafe3 100755 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java @@ -223,7 +223,8 @@ public class XSSFPicture extends XSSFShape { * Return the dimension of this image * * @param part the package part holding raw picture data - * @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG, Workbook#PICTURE_TYPE_PNG or Workbook#PICTURE_TYPE_DIB) + * @param type type of the picture: {@link Workbook#PICTURE_TYPE_JPEG}, + * {@link Workbook#PICTURE_TYPE_PNG} or {@link Workbook#PICTURE_TYPE_DIB} * * @return image dimension in pixels */ diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java index 851c85af5..736eea053 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java @@ -101,12 +101,12 @@ public class XSSFPictureData extends POIXMLDocumentPart implements PictureData { * Return an integer constant that specifies type of this picture * * @return an integer constant that specifies type of this picture - * @see Workbook#PICTURE_TYPE_EMF - * @see Workbook#PICTURE_TYPE_WMF - * @see Workbook#PICTURE_TYPE_PICT - * @see Workbook#PICTURE_TYPE_JPEG - * @see Workbook#PICTURE_TYPE_PNG - * @see Workbook#PICTURE_TYPE_DIB + * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_EMF + * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_WMF + * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_PICT + * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_JPEG + * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_PNG + * @see org.apache.poi.ss.usermodel.Workbook#PICTURE_TYPE_DIB */ public int getPictureType(){ String contentType = getPackagePart().getContentType(); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java index 792e14ca8..539e014d9 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java @@ -163,7 +163,7 @@ public class XSSFRow implements Row, Comparable { /** * Returns the cell at the given (0 based) index, - * with the {@link MissingCellPolicy} from the parent Workbook. + * with the {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} from the parent Workbook. * * @return the cell at the given (0 based) index */ @@ -172,7 +172,7 @@ public class XSSFRow implements Row, Comparable { } /** - * Returns the cell at the given (0 based) index, with the specified {@link MissingCellPolicy} + * Returns the cell at the given (0 based) index, with the specified {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} * * @return the cell at the given (0 based) index * @throws IllegalArgumentException if cellnum < 0 or the specified MissingCellPolicy is invalid diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java index de59bb3fa..5a4203363 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java @@ -254,12 +254,12 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable - * @return */ public ExEmbed getExEmbed(){ if(_exEmbed == null){ diff --git a/src/scratchpad/src/org/apache/poi/hslf/record/AnimationInfoAtom.java b/src/scratchpad/src/org/apache/poi/hslf/record/AnimationInfoAtom.java index 66982ea20..4de22e50c 100755 --- a/src/scratchpad/src/org/apache/poi/hslf/record/AnimationInfoAtom.java +++ b/src/scratchpad/src/org/apache/poi/hslf/record/AnimationInfoAtom.java @@ -203,14 +203,14 @@ public class AnimationInfoAtom extends RecordAtom /** * A signed integer that specifies the delay time, in milliseconds, before the animation starts to play. - * If {@link Automatic} is 0x1, this value MUST be greater than or equal to 0; otherwise, this field MUST be ignored. + * If {@link #Automatic} is 0x1, this value MUST be greater than or equal to 0; otherwise, this field MUST be ignored. */ public int getDelayTime(){ return LittleEndian.getInt(_recdata, 12); } /** * A signed integer that specifies the delay time, in milliseconds, before the animation starts to play. - * If {@link Automatic} is 0x1, this value MUST be greater than or equal to 0; otherwise, this field MUST be ignored. + * If {@link #Automatic} is 0x1, this value MUST be greater than or equal to 0; otherwise, this field MUST be ignored. */ public void setDelayTime(int id){ LittleEndian.putInt(_recdata, 12, id); diff --git a/src/scratchpad/src/org/apache/poi/hslf/record/HeadersFootersAtom.java b/src/scratchpad/src/org/apache/poi/hslf/record/HeadersFootersAtom.java index a9457a6de..1c90b9596 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/record/HeadersFootersAtom.java +++ b/src/scratchpad/src/org/apache/poi/hslf/record/HeadersFootersAtom.java @@ -34,13 +34,15 @@ public class HeadersFootersAtom extends RecordAtom { /** * A bit that specifies whether the date is displayed in the footer. - * @see {@link #getMask()}, {@link #setMask(int)}}, + * @see #getMask() + * @see #setMask(int) */ public static final int fHasDate = 1; /** * A bit that specifies whether the current datetime is used for displaying the datetime. - * @see {@link #getMask()}, {@link #setMask(int)}}, + * @see #getMask() + * @see #setMask(int) */ public static final int fHasTodayDate = 2; @@ -48,28 +50,32 @@ public class HeadersFootersAtom extends RecordAtom { * A bit that specifies whether the date specified in UserDateAtom record * is used for displaying the datetime. * - * @see {@link #getMask()}, {@link #setMask(int)}}, + * @see #getMask() + * @see #setMask(int) */ public static final int fHasUserDate = 4; /** * A bit that specifies whether the slide number is displayed in the footer. * - * @see {@link #getMask()}, {@link #setMask(int)}}, + * @see #getMask() + * @see #setMask(int) */ public static final int fHasSlideNumber = 8; /** * bit that specifies whether the header text is displayed. * - * @see {@link #getMask()}, {@link #setMask(int)}}, + * @see #getMask() + * @see #setMask(int) */ public static final int fHasHeader = 16; /** * bit that specifies whether the footer text is displayed. * - * @see {@link #getMask()}, {@link #setMask(int)}}, + * @see #getMask() + * @see #setMask(int) */ public static final int fHasFooter = 32; diff --git a/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java b/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java index 3669a5333..46bebadcc 100644 --- a/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java +++ b/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java @@ -75,7 +75,6 @@ public class MAPIMessage { /** * Gets a string value based on the passed chunk. * @param chunk - * @return * @throws ChunkNotFoundException */ public String getStringFromChunk(StringChunk chunk) throws ChunkNotFoundException { @@ -97,7 +96,6 @@ public class MAPIMessage { /** * Gets the subject line of the Outlook Message - * @return * @throws ChunkNotFoundException */ public String getSubject() throws ChunkNotFoundException { @@ -108,7 +106,6 @@ public class MAPIMessage { /** * Gets the display value of the "TO" line of the outlook message * This is not the actual list of addresses/values that will be sent to if you click Reply in the email. - * @return * @throws ChunkNotFoundException */ public String getDisplayTo() throws ChunkNotFoundException { @@ -118,7 +115,6 @@ public class MAPIMessage { /** * Gets the display value of the "FROM" line of the outlook message * This is not the actual address that was sent from but the formated display of the user name. - * @return * @throws ChunkNotFoundException */ public String getDisplayFrom() throws ChunkNotFoundException { @@ -128,7 +124,6 @@ public class MAPIMessage { /** * Gets the display value of the "TO" line of the outlook message * This is not the actual list of addresses/values that will be sent to if you click Reply in the email. - * @return * @throws ChunkNotFoundException */ public String getDisplayCC() throws ChunkNotFoundException { @@ -138,7 +133,6 @@ public class MAPIMessage { /** * Gets the display value of the "TO" line of the outlook message * This is not the actual list of addresses/values that will be sent to if you click Reply in the email. - * @return * @throws ChunkNotFoundException */ public String getDisplayBCC() throws ChunkNotFoundException { @@ -149,7 +143,6 @@ public class MAPIMessage { /** * Gets the conversation topic of the parsed Outlook Message. * This is the part of the subject line that is after the RE: and FWD: - * @return * @throws ChunkNotFoundException */ public String getConversationTopic() throws ChunkNotFoundException { @@ -161,7 +154,6 @@ public class MAPIMessage { * (Yes, you can use this to determine if a message is a calendar item, note, or actual outlook Message) * For emails the class will be IPM.Note * - * @return * @throws ChunkNotFoundException */ public String getMessageClass() throws ChunkNotFoundException { diff --git a/src/scratchpad/src/org/apache/poi/hsmf/datatypes/Chunk.java b/src/scratchpad/src/org/apache/poi/hsmf/datatypes/Chunk.java index 785a336fa..7eaca4f1b 100644 --- a/src/scratchpad/src/org/apache/poi/hsmf/datatypes/Chunk.java +++ b/src/scratchpad/src/org/apache/poi/hsmf/datatypes/Chunk.java @@ -26,7 +26,6 @@ abstract public class Chunk { /** * Gets the id of this chunk - * @return */ public int getChunkId() { return this.chunkId; @@ -34,7 +33,6 @@ abstract public class Chunk { /** * Gets the numeric type of this chunk. - * @return */ public int getType() { return this.type; @@ -42,7 +40,6 @@ abstract public class Chunk { /** * Creates a string to use to identify this chunk in the POI file system object. - * @return */ public String getEntryName() { String type = Integer.toHexString(this.type); @@ -56,7 +53,6 @@ abstract public class Chunk { /** * Gets a reference to a ByteArrayOutputStream that contains the value of this chunk. - * @return */ public abstract ByteArrayOutputStream getValueByteArray(); diff --git a/src/scratchpad/src/org/apache/poi/hsmf/parsers/POIFSChunkParser.java b/src/scratchpad/src/org/apache/poi/hsmf/parsers/POIFSChunkParser.java index c1e174e08..108a28b4c 100644 --- a/src/scratchpad/src/org/apache/poi/hsmf/parsers/POIFSChunkParser.java +++ b/src/scratchpad/src/org/apache/poi/hsmf/parsers/POIFSChunkParser.java @@ -66,7 +66,6 @@ public class POIFSChunkParser { /** * Get a reference to the FileSystem object that this object is currently using. - * @return */ public POIFSFileSystem getFileSystem() { return this.fs; @@ -117,7 +116,6 @@ public class POIFSChunkParser { /** * Pull the chunk data that's stored in this object's hashmap out and return it as a HashMap. * @param entryName - * @return */ public Object getChunk(HashMap dirMap, String entryName) { if(dirMap == null) return null; @@ -143,8 +141,8 @@ public class POIFSChunkParser { /** * Pulls a ByteArrayOutputStream from this objects HashMap, this can be used to read a byte array of the contents of the given chunk. - * @param directoryMap, chunk - * @return + * @param dirNode + * @param chunk * @throws ChunkNotFoundException */ public Chunk getDocumentNode(HashMap dirNode, Chunk chunk) throws ChunkNotFoundException { @@ -161,7 +159,6 @@ public class POIFSChunkParser { /** * Pulls a Chunk out of this objects root Node tree. * @param chunk - * @return * @throws ChunkNotFoundException */ public Chunk getDocumentNode(Chunk chunk) throws ChunkNotFoundException { diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java b/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java index 9681741d9..af9f5e8fb 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java @@ -72,7 +72,7 @@ public class PicturesTable /** * - * @param document + * @param _document * @param _dataStream */ public PicturesTable(HWPFDocument _document, byte[] _dataStream, byte[] _mainStream, FSPATable fspa, EscherRecordHolder dgg) diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/TextPiece.java b/src/scratchpad/src/org/apache/poi/hwpf/model/TextPiece.java index bf2cf3014..57cd9099e 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/TextPiece.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/TextPiece.java @@ -105,7 +105,6 @@ public class TextPiece extends PropertyNode implements Comparable * Works only in characters, not in bytes! * @param start Local start position, in characters * @param end Local end position, in characters - * @return */ public String substring(int start, int end) { diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/TextPieceTable.java b/src/scratchpad/src/org/apache/poi/hwpf/model/TextPieceTable.java index 129603463..f13e6ecd1 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/TextPieceTable.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/TextPieceTable.java @@ -157,7 +157,7 @@ public class TextPieceTable * In a very evil fashion, you have to actually * know this to make sense of character and * paragraph properties :( - * @param cp The character offset to check about + * @param bytePos The character offset to check about */ public boolean isUnicodeAtByteOffset(int bytePos) { boolean lastWas = false; diff --git a/src/scratchpad/src/org/apache/poi/hwpf/usermodel/HeaderStories.java b/src/scratchpad/src/org/apache/poi/hwpf/usermodel/HeaderStories.java index 574c065ec..e8f231b6c 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/usermodel/HeaderStories.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/usermodel/HeaderStories.java @@ -89,7 +89,6 @@ public class HeaderStories { * Returns the correct, defined header for the given * one based page * @param pageNumber The one based page number - * @return */ public String getHeader(int pageNumber) { // First page header is optional, only return @@ -124,7 +123,6 @@ public class HeaderStories { * Returns the correct, defined footer for the given * one based page * @param pageNumber The one based page number - * @return */ public String getFooter(int pageNumber) { // First page footer is optional, only return diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java index 935cf24f8..828a87238 100644 --- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java +++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java @@ -81,7 +81,7 @@ public final class TestHSSFFormulaEvaluator extends TestCase { } /** - * {@link HSSFFormulaEvaluator#evaluate(HSSFCell)} should behave the same whether the cell + * {@link HSSFFormulaEvaluator#evaluate(org.apache.poi.ss.usermodel.Cell)} should behave the same whether the cell * is null or blank. */ public void testEvaluateBlank() { diff --git a/src/testcases/org/apache/poi/ss/formula/TestCellCacheEntry.java b/src/testcases/org/apache/poi/ss/formula/TestCellCacheEntry.java index d5e75dd2a..a9a259175 100644 --- a/src/testcases/org/apache/poi/ss/formula/TestCellCacheEntry.java +++ b/src/testcases/org/apache/poi/ss/formula/TestCellCacheEntry.java @@ -23,7 +23,7 @@ import org.apache.poi.hssf.record.formula.eval.NumberEval; import org.apache.poi.hssf.record.formula.eval.ValueEval; /** - * Tests {@link CellCacheEntry}. + * Tests {@link org.apache.poi.ss.formula.CellCacheEntry}. * * @author Josh Micich */ diff --git a/src/testcases/org/apache/poi/ss/formula/TestEvaluationCache.java b/src/testcases/org/apache/poi/ss/formula/TestEvaluationCache.java index d42bfacd2..311367b0a 100644 --- a/src/testcases/org/apache/poi/ss/formula/TestEvaluationCache.java +++ b/src/testcases/org/apache/poi/ss/formula/TestEvaluationCache.java @@ -47,7 +47,7 @@ import org.apache.poi.ss.formula.PlainCellCache.Loc; import org.apache.poi.ss.usermodel.CellValue; /** - * Tests {@link EvaluationCache}. Makes sure that where possible (previously calculated) cached + * Tests {@link org.apache.poi.ss.formula.EvaluationCache}. Makes sure that where possible (previously calculated) cached * values are used. Also checks that changing cell values causes the correct (minimal) set of * dependent cached values to be cleared. *