This is an automated email from the ASF dual-hosted git repository.
fanningpj 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 f73913cd84 deprecate old picture type method (#865)
f73913cd84 is described below
commit f73913cd840ad19465eae2b863914c97349dc0b6
Author: PJ Fanning <[email protected]>
AuthorDate: Fri Jul 25 15:28:51 2025 +0100
deprecate old picture type method (#865)
* deprecate old picture type method
* more changes
---
.../poi/examples/xwpf/usermodel/SimpleImages.java | 26 +++++++++++-----------
.../apache/poi/xwpf/usermodel/XWPFComments.java | 4 ++++
.../apache/poi/xwpf/usermodel/XWPFDocument.java | 4 ++++
.../poi/xwpf/usermodel/XWPFHeaderFooter.java | 4 ++++
.../apache/poi/xwpf/usermodel/XWPFPictureData.java | 5 ++++-
.../org/apache/poi/xwpf/usermodel/XWPFRun.java | 4 +++-
.../apache/poi/xwpf/usermodel/TestXWPFComment.java | 3 ++-
.../poi/xwpf/usermodel/TestXWPFPictureData.java | 2 +-
.../org/apache/poi/xwpf/usermodel/TestXWPFRun.java | 8 +++----
9 files changed, 39 insertions(+), 21 deletions(-)
diff --git
a/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleImages.java
b/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleImages.java
index 1f996cfd1f..0e4c5670c0 100644
---
a/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleImages.java
+++
b/poi-examples/src/main/java/org/apache/poi/examples/xwpf/usermodel/SimpleImages.java
@@ -22,10 +22,10 @@ import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
+import org.apache.poi.common.usermodel.PictureType;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.util.Units;
import org.apache.poi.xwpf.usermodel.BreakType;
-import org.apache.poi.xwpf.usermodel.Document;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
@@ -45,30 +45,30 @@ public final class SimpleImages {
XWPFRun r = p.createRun();
for (String imgFile : args) {
- int format;
+ PictureType format;
if (imgFile.endsWith(".emf")) {
- format = Document.PICTURE_TYPE_EMF;
+ format = PictureType.EMF;
} else if (imgFile.endsWith(".wmf")) {
- format = Document.PICTURE_TYPE_WMF;
+ format = PictureType.WMF;
} else if (imgFile.endsWith(".pict")) {
- format = Document.PICTURE_TYPE_PICT;
+ format = PictureType.PICT;
} else if (imgFile.endsWith(".jpeg") ||
imgFile.endsWith(".jpg")) {
- format = Document.PICTURE_TYPE_JPEG;
+ format = PictureType.JPEG;
} else if (imgFile.endsWith(".png")) {
- format = Document.PICTURE_TYPE_PNG;
+ format = PictureType.PNG;
} else if (imgFile.endsWith(".dib")) {
- format = Document.PICTURE_TYPE_DIB;
+ format = PictureType.DIB;
} else if (imgFile.endsWith(".gif")) {
- format = Document.PICTURE_TYPE_GIF;
+ format = PictureType.GIF;
} else if (imgFile.endsWith(".tiff")) {
- format = Document.PICTURE_TYPE_TIFF;
+ format = PictureType.TIFF;
} else if (imgFile.endsWith(".eps")) {
- format = Document.PICTURE_TYPE_EPS;
+ format = PictureType.EPS;
} else if (imgFile.endsWith(".bmp")) {
- format = Document.PICTURE_TYPE_BMP;
+ format = PictureType.BMP;
} else if (imgFile.endsWith(".wpg")) {
- format = Document.PICTURE_TYPE_WPG;
+ format = PictureType.WPG;
} else {
System.err.println("Unsupported picture: " + imgFile +
". Expected
emf|wmf|pict|jpeg|png|dib|gif|tiff|eps|bmp|wpg");
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java
index cb301c226e..5cbba917eb 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFComments.java
@@ -25,6 +25,7 @@ import
org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.Internal;
+import org.apache.poi.util.Removal;
import org.apache.xmlbeans.XmlException;
import org.apache.xmlbeans.XmlOptions;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTComment;
@@ -141,7 +142,10 @@ public class XWPFComments extends POIXMLDocumentPart {
* @return the index to this picture (0 based), the added picture can be
* obtained from {@link #getAllPictures()} .
* @throws InvalidFormatException If the format of the picture is not
known.
+ * @deprecated use {@link #addPictureData(byte[], PictureType)} instead.
*/
+ @Deprecated
+ @Removal(version = "7.0.0")
public String addPictureData(byte[] pictureData, int format) throws
InvalidFormatException {
return addPictureData(pictureData, PictureType.findByOoxmlId(format));
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
index 88a603e160..eb8c4c30c9 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
@@ -60,6 +60,7 @@ import org.apache.poi.openxml4j.opc.TargetMode;
import org.apache.poi.poifs.crypt.HashAlgorithm;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.Internal;
+import org.apache.poi.util.Removal;
import org.apache.poi.wp.usermodel.HeaderFooterType;
import org.apache.poi.xddf.usermodel.chart.XDDFChart;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
@@ -1724,7 +1725,10 @@ public class XWPFDocument extends POIXMLDocument
implements Document, IBody {
* @return the next free ImageNumber
* @throws InvalidFormatException If the format of the picture is not
known.
* @see #getNextPicNameNumber(PictureType)
+ * @deprecated use {@link #getNextPicNameNumber(PictureType)} instead.
*/
+ @Deprecated
+ @Removal(version = "7.0.0")
public int getNextPicNameNumber(int format) throws InvalidFormatException {
return getNextPicNameNumber(PictureType.findByOoxmlId(format));
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
index 6beb0eadf7..3c80d26a0a 100644
---
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
+++
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
@@ -31,6 +31,7 @@ import
org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.util.IOUtils;
import org.apache.poi.util.Internal;
+import org.apache.poi.util.Removal;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHdrFtr;
@@ -235,7 +236,10 @@ public abstract class XWPFHeaderFooter extends
POIXMLDocumentPart implements IBo
* @return the index to this picture (0 based), the added picture can be
obtained from {@link #getAllPictures()} .
* @throws InvalidFormatException If the format of the picture is not
known.
* @see #addPictureData(byte[], PictureType)
+ * @deprecated Use {@link #addPictureData(byte[], PictureType)} instead.
*/
+ @Deprecated
+ @Removal(version = "7.0.0")
public String addPictureData(byte[] pictureData, int format) throws
InvalidFormatException {
return addPictureData(pictureData, PictureType.findByOoxmlId(format));
}
diff --git
a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java
index 7d541a627f..7749977f01 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFPictureData.java
@@ -28,6 +28,7 @@ import org.apache.poi.ooxml.POIXMLRelation;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.util.IOUtils;
+import org.apache.poi.util.Removal;
/**
* Raw picture data, normally attached to a WordprocessingML Drawing.
@@ -152,8 +153,10 @@ public class XWPFPictureData extends POIXMLDocumentPart {
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_GIF
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_DIB
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_SVG
- * @see #getPictureTypeEnum()
+ * @deprecated use #getPictureTypeEnum()
*/
+ @Deprecated
+ @Removal(version = "7.0.0") // repurpose to return PictureType
public int getPictureType() {
String contentType = getPackagePart().getContentType();
for (int i = 0; i < RELATIONS.length; i++) {
diff --git a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
index eb159bfeed..a8cfd67803 100644
--- a/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
@@ -1238,8 +1238,10 @@ public class XWPFRun implements ISDTContents,
IRunElement, CharacterRun {
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_GIF
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_DIB
* @see org.apache.poi.xwpf.usermodel.Document#PICTURE_TYPE_SVG
- * @see #addPicture(InputStream, PictureType, String, int, int)
+ * @deprecated use #addPicture(InputStream, PictureType, String, int, int)
*/
+ @Deprecated
+ @Removal(version = "7.0.0")
public XWPFPicture addPicture(InputStream pictureData, int pictureType,
String filename, int width, int height)
throws InvalidFormatException, IOException {
return addPicture(pictureData, PictureType.findByOoxmlId(pictureType),
filename, width, height);
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFComment.java
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFComment.java
index 79ffa2d701..256fe9fe7e 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFComment.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFComment.java
@@ -16,6 +16,7 @@
==================================================================== */
package org.apache.poi.xwpf.usermodel;
+import org.apache.poi.common.usermodel.PictureType;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.util.LocaleUtil;
import org.apache.poi.xwpf.XWPFTestDataSamples;
@@ -100,7 +101,7 @@ class TestXWPFComment {
XWPFParagraph paragraph = comment.createParagraph();
XWPFRun r = paragraph.createRun();
r.addPicture(new ByteArrayInputStream(new byte[0]),
- Document.PICTURE_TYPE_JPEG, "test.jpg", 21, 32);
+ PictureType.JPEG, "test.jpg", 21, 32);
assertEquals(1, comments.getAllPictures().size());
assertEquals(1, doc.getAllPackagePictures().size());
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFPictureData.java
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFPictureData.java
index 926ea82868..452c869995 100644
---
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFPictureData.java
+++
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFPictureData.java
@@ -117,7 +117,7 @@ class TestXWPFPictureData {
// Add a picture to the first paragraph
header.getParagraphs().get(0).getRuns().get(0).addPicture(
new ByteArrayInputStream(new byte[]{1, 2, 3, 4}),
- Document.PICTURE_TYPE_JPEG, "test.jpg", 2, 2);
+ PictureType.JPEG, "test.jpg", 2, 2);
// Check
verifyOneHeaderPicture(doc);
diff --git
a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFRun.java
b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFRun.java
index f9d6886ec5..87561e720d 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFRun.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xwpf/usermodel/TestXWPFRun.java
@@ -553,7 +553,7 @@ class TestXWPFRun {
assertEquals(0, doc.getAllPictures().size());
assertEquals(0, r.getEmbeddedPictures().size());
- r.addPicture(new ByteArrayInputStream(new byte[0]),
Document.PICTURE_TYPE_JPEG, "test.jpg", 21, 32);
+ r.addPicture(new ByteArrayInputStream(new byte[0]), PictureType.JPEG,
"test.jpg", 21, 32);
assertEquals(1, doc.getAllPictures().size());
assertEquals(1, r.getEmbeddedPictures().size());
@@ -581,7 +581,7 @@ class TestXWPFRun {
assertEquals(0, hdr.getAllPictures().size());
assertEquals(0, r.getEmbeddedPictures().size());
- r.addPicture(new ByteArrayInputStream(new byte[0]),
Document.PICTURE_TYPE_JPEG, "test.jpg", 21, 32);
+ r.addPicture(new ByteArrayInputStream(new byte[0]),
PictureType.JPEG, "test.jpg", 21, 32);
assertEquals(1, hdr.getAllPictures().size());
assertEquals(1, r.getEmbeddedPictures().size());
@@ -628,7 +628,7 @@ class TestXWPFRun {
try (XWPFDocument document = new XWPFDocument()) {
document.createParagraph().createRun().addPicture(
- new ByteArrayInputStream(image),
Document.PICTURE_TYPE_JPEG, "test.jpg", Units.toEMU(300), Units.toEMU(100));
+ new ByteArrayInputStream(image), PictureType.JPEG,
"test.jpg", Units.toEMU(300), Units.toEMU(100));
try (XWPFDocument docBack = writeOutAndReadBack(document)) {
List<XWPFPicture> pictures =
docBack.getParagraphArray(0).getRuns().get(0).getEmbeddedPictures();
@@ -859,7 +859,7 @@ class TestXWPFRun {
assertEquals(0, hdr.getAllPictures().size());
assertEquals(0, r.getEmbeddedPictures().size());
- r.addPicture(new ByteArrayInputStream(new byte[0]),
Document.PICTURE_TYPE_JPEG, "test.jpg", 21, 32);
+ r.addPicture(new ByteArrayInputStream(new byte[0]),
PictureType.JPEG, "test.jpg", 21, 32);
assertEquals(1, hdr.getAllPictures().size());
assertEquals(1, r.getEmbeddedPictures().size());
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
