This is an automated email from the ASF dual-hosted git repository.
centic9 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/poi.git
The following commit(s) were added to refs/heads/trunk by this push:
new d1172411ed Open up xssfb to simplify client usage/modifications.
(#1042)
d1172411ed is described below
commit d1172411ed834fa154a5df688b02cfe71d776218
Author: Tim Allison <[email protected]>
AuthorDate: Sat Apr 18 10:01:55 2026 -0400
Open up xssfb to simplify client usage/modifications. (#1042)
* Open up xssfb to simplify client usage/modifications.
* add @since and simplify with Math.toIntExact
---
.../apache/poi/xssf/binary/XSSFBCellHeader.java | 2 +-
.../org/apache/poi/xssf/binary/XSSFBCellRange.java | 46 ++++++++++++++--------
.../apache/poi/xssf/binary/XSSFBCommentsTable.java | 5 +--
.../poi/xssf/binary/XSSFBHyperlinksTable.java | 2 +-
.../org/apache/poi/xssf/binary/XSSFBRichStr.java | 4 +-
.../poi/xssf/binary/XSSFBSharedStringsTable.java | 4 +-
.../apache/poi/xssf/binary/XSSFBSheetHandler.java | 4 +-
.../org/apache/poi/xssf/binary/XSSFBUtils.java | 17 +-------
8 files changed, 40 insertions(+), 44 deletions(-)
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellHeader.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellHeader.java
index 6e3d0c0c9f..4151f02e20 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellHeader.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellHeader.java
@@ -40,7 +40,7 @@ class XSSFBCellHeader {
* @param cell cell buffer to update
*/
public static void parse(byte[] data, int offset, int currentRow,
XSSFBCellHeader cell) {
- int colNum = XSSFBUtils.castToInt(LittleEndian.getUInt(data, offset));
offset += LittleEndianConsts.INT_SIZE;
+ int colNum = Math.toIntExact(LittleEndian.getUInt(data, offset));
offset += LittleEndianConsts.INT_SIZE;
int styleIdx = XSSFBUtils.get24BitInt(data, offset); offset += 3;
//TODO: range checking
boolean showPhonetic = false;//TODO: fill this out
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellRange.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellRange.java
index d090002a28..649473cc93 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellRange.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCellRange.java
@@ -23,37 +23,49 @@ import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.LittleEndianConsts;
/**
- * @since 3.16-beta3
+ * @since 6.0.0
*/
@Internal
-class XSSFBCellRange {
+public class XSSFBCellRange {
+
//TODO: Convert this to generate an AreaReference
+ public static final int length = 4 * LittleEndianConsts.INT_SIZE;
+
+ private int firstRow;
+ private int lastRow;
+ private int firstCol;
+ private int lastCol;
+
+ public XSSFBCellRange(int firstRow, int lastRow, int firstCol, int
lastCol) {
+ this.firstRow = firstRow;
+ this.lastRow = lastRow;
+ this.firstCol = firstCol;
+ this.lastCol = lastCol;
+ }
+
+ XSSFBCellRange() {
+ }
- public static final int length = 4* LittleEndianConsts.INT_SIZE;
/**
* Parses an RfX cell range from the data starting at the offset.
- * This performs no range checking.
* @param data raw bytes
* @param offset offset at which to start reading from data
- * @param cellRange to overwrite. If null, a new cellRange will be created.
- * @return a mutable cell range.
+ * @param cellRange to update. If null, a new cellRange will be created.
+ * @return the updated or new cell range
*/
public static XSSFBCellRange parse(byte[] data, int offset, XSSFBCellRange
cellRange) {
if (cellRange == null) {
cellRange = new XSSFBCellRange();
}
- cellRange.firstRow = XSSFBUtils.castToInt(LittleEndian.getUInt(data,
offset)); offset += LittleEndianConsts.INT_SIZE;
- cellRange.lastRow = XSSFBUtils.castToInt(LittleEndian.getUInt(data,
offset)); offset += LittleEndianConsts.INT_SIZE;
- cellRange.firstCol = XSSFBUtils.castToInt(LittleEndian.getUInt(data,
offset)); offset += LittleEndianConsts.INT_SIZE;
- cellRange.lastCol = XSSFBUtils.castToInt(LittleEndian.getUInt(data,
offset));
-
+ cellRange.firstRow = Math.toIntExact(LittleEndian.getUInt(data,
offset)); offset += LittleEndianConsts.INT_SIZE;
+ cellRange.lastRow = Math.toIntExact(LittleEndian.getUInt(data,
offset)); offset += LittleEndianConsts.INT_SIZE;
+ cellRange.firstCol = Math.toIntExact(LittleEndian.getUInt(data,
offset)); offset += LittleEndianConsts.INT_SIZE;
+ cellRange.lastCol = Math.toIntExact(LittleEndian.getUInt(data,
offset));
return cellRange;
}
- int firstRow;
- int lastRow;
- int firstCol;
- int lastCol;
-
-
+ public int getFirstRow() { return firstRow; }
+ public int getLastRow() { return lastRow; }
+ public int getFirstCol() { return firstCol; }
+ public int getLastCol() { return lastCol; }
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCommentsTable.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCommentsTable.java
index 057f61ee20..1c599f4533 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCommentsTable.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBCommentsTable.java
@@ -61,11 +61,10 @@ public class XSSFBCommentsTable extends XSSFBParser {
switch (recordType) {
case BrtBeginComment:
int offset = 0;
- authorId = XSSFBUtils.castToInt(LittleEndian.getUInt(data));
offset += LittleEndianConsts.INT_SIZE;
+ authorId = Math.toIntExact(LittleEndian.getUInt(data)); offset
+= LittleEndianConsts.INT_SIZE;
cellRange = XSSFBCellRange.parse(data, offset, cellRange);
- offset+= XSSFBCellRange.length;
//for strict parsing; confirm that firstRow==lastRow and
firstCol==colLats (2.4.28)
- cellAddress = new CellAddress(cellRange.firstRow,
cellRange.firstCol);
+ cellAddress = new CellAddress(cellRange.getFirstRow(),
cellRange.getFirstCol());
break;
case BrtCommentText:
XSSFBRichStr xssfbRichStr = XSSFBRichStr.build(data, 0);
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBHyperlinksTable.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBHyperlinksTable.java
index e77308db6e..9a861ed48f 100644
---
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBHyperlinksTable.java
+++
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBHyperlinksTable.java
@@ -149,7 +149,7 @@ public class XSSFBHyperlinksTable {
xlWideStringBuffer.setLength(0);
/*offset +=*/ XSSFBUtils.readXLWideString(data, offset,
xlWideStringBuffer);
String display = xlWideStringBuffer.toString();
- CellRangeAddress cellRangeAddress = new
CellRangeAddress(hyperlinkCellRange.firstRow, hyperlinkCellRange.lastRow,
hyperlinkCellRange.firstCol, hyperlinkCellRange.lastCol);
+ CellRangeAddress cellRangeAddress = new
CellRangeAddress(hyperlinkCellRange.getFirstRow(),
hyperlinkCellRange.getLastRow(), hyperlinkCellRange.getFirstCol(),
hyperlinkCellRange.getLastCol());
String url = relIdToHyperlink.get(relId);
if (location.isEmpty()) {
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBRichStr.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBRichStr.java
index 7e18a1a4dc..61719d9831 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBRichStr.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBRichStr.java
@@ -20,10 +20,10 @@ package org.apache.poi.xssf.binary;
import org.apache.poi.util.Internal;
/**
- * @since 3.16-beta3
+ * @since 6.0.0
*/
@Internal
-class XSSFBRichStr {
+public class XSSFBRichStr {
public static XSSFBRichStr build(byte[] bytes, int offset) throws
XSSFBParseException {
byte first = bytes[offset];
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSharedStringsTable.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSharedStringsTable.java
index 82625070f1..7480ae4c1b 100644
---
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSharedStringsTable.java
+++
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSharedStringsTable.java
@@ -132,8 +132,8 @@ public class XSSFBSharedStringsTable implements
SharedStrings {
strings.add(rstr.getString());
break;
case BrtBeginSst:
- count = XSSFBUtils.castToInt(LittleEndian.getUInt(data,0));
- uniqueCount =
XSSFBUtils.castToInt(LittleEndian.getUInt(data, 4));
+ count = Math.toIntExact(LittleEndian.getUInt(data,0));
+ uniqueCount = Math.toIntExact(LittleEndian.getUInt(data,
4));
break;
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java
index 8e89cadc16..725204006b 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBSheetHandler.java
@@ -130,7 +130,7 @@ public class XSSFBSheetHandler extends XSSFBParser {
switch(type) {
case BrtRowHdr:
- int rw = XSSFBUtils.castToInt(LittleEndian.getUInt(data, 0));
+ int rw = Math.toIntExact(LittleEndian.getUInt(data, 0));
if (rw > 0x00100000) {//could make sure this is larger than
currentRow, according to spec?
throw new XSSFBParseException("Row number beyond allowable
range: "+rw);
}
@@ -298,7 +298,7 @@ public class XSSFBSheetHandler extends XSSFBParser {
private void handleBrtCellIsst(byte[] data) {
beforeCellValue(data);
- int idx = XSSFBUtils.castToInt(LittleEndian.getUInt(data,
XSSFBCellHeader.length));
+ int idx = Math.toIntExact(LittleEndian.getUInt(data,
XSSFBCellHeader.length));
RichTextString rtss = stringsTable.getItemAt(idx);
handleStringCellValue(rtss.getString());
}
diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBUtils.java
b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBUtils.java
index 6f1dd70bd3..cef9e6807f 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBUtils.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/binary/XSSFBUtils.java
@@ -20,7 +20,6 @@ package org.apache.poi.xssf.binary;
import java.nio.charset.StandardCharsets;
-import org.apache.poi.ooxml.POIXMLException;
import org.apache.poi.util.Internal;
import org.apache.poi.util.LittleEndian;
@@ -85,23 +84,9 @@ public class XSSFBUtils {
return numBytes;
}
- static int castToInt(long val) {
- if (val < Integer.MAX_VALUE && val > Integer.MIN_VALUE) {
- return (int)val;
- }
- throw new POIXMLException("val ("+val+") can't be cast to int");
- }
-
- static short castToShort(int val) {
- if (val < Short.MAX_VALUE && val > Short.MIN_VALUE) {
- return (short)val;
- }
- throw new POIXMLException("val ("+val+") can't be cast to short");
-
- }
//TODO: move to LittleEndian?
- static int get24BitInt( byte[] data, int offset) {
+ static int get24BitInt(byte[] data, int offset) {
int i = offset;
int b0 = data[i++] & 0xFF;
int b1 = data[i++] & 0xFF;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]