[bug-62435] Rename getAllEmbedds method to getAllEmbeddedParts (getAllEmbedds is...

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1833059 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java b/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java
index 2ad0347f7b454d440d1f84af566e65deb79700e4..4fd640ca70a4cd00e4759ec29892c4fc6e7c0741 100644 (file)
--- a/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java
+++ b/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java
@@ -94,7 +94,7 @@ public class LoadEmbedded {
    }
    
    public static void loadEmbedded(XSSFWorkbook workbook) throws IOException, InvalidFormatException, OpenXML4JException, XmlException {
-       for (PackagePart pPart : workbook.getAllEmbedds()) {
+       for (PackagePart pPart : workbook.getAllEmbeddedParts()) {
            String contentType = pPart.getContentType();
            if (contentType.equals("application/vnd.ms-excel")) {
                // Excel Workbook - either binary or OpenXML

diff --git a/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java b/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java
index 5716679dbbf767030c2fd6f85a35687aafca16b2..82e5705f7d8df8dc181200d950a5cd7e0da2c685 100644 (file)
--- a/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java
+++ b/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java
@@ -47,7 +47,7 @@ public final class DataExtraction {
             is.close();
 
             // Get the document's embedded files.
-            for (PackagePart p : ppt.getAllEmbedds()) {
+            for (PackagePart p : ppt.getAllEmbeddedParts()) {
                 String type = p.getContentType();
                 // typically file name
                 String name = p.getPartName().getName();

diff --git a/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java b/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java
index b760acac03bee993573125f6d1c5ef7d5ef7aaad..1931af75575ca73775b2bc587d55dc8954881792 100644 (file)
--- a/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java
+++ b/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java
@@ -33,7 +33,7 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument;
 public class EmbeddedObjects {
     public static void main(String[] args) throws Exception {
         try (XSSFWorkbook workbook = new XSSFWorkbook(args[0])) {
-            for (PackagePart pPart : workbook.getAllEmbedds()) {
+            for (PackagePart pPart : workbook.getAllEmbeddedParts()) {
                 String contentType = pPart.getContentType();
                 try (InputStream is = pPart.getInputStream()) {
                     Closeable document;

diff --git a/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java b/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java
index ef57d799952246741d1f108a0f1df2ba3199d2f1..c21f595d130eced7fb82c4c8abdf6fe198966f10 100644 (file)
--- a/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java
+++ b/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java
@@ -99,7 +99,7 @@ public class UpdateEmbeddedDoc {
      *                             file system.
      */
     public void updateEmbeddedDoc() throws OpenXML4JException, IOException {
-        List<PackagePart> embeddedDocs = this.doc.getAllEmbedds();
+        List<PackagePart> embeddedDocs = this.doc.getAllEmbeddedParts();
         for (PackagePart pPart : embeddedDocs) {
             String ext = pPart.getPartName().getExtension();
             if (BINARY_EXTENSION.equals(ext) || OPENXML_EXTENSION.equals(ext)) {
@@ -153,7 +153,7 @@ public class UpdateEmbeddedDoc {
      *                             file system.
      */
     public void checkUpdatedDoc() throws OpenXML4JException, IOException {
-        for (PackagePart pPart : this.doc.getAllEmbedds()) {
+        for (PackagePart pPart : this.doc.getAllEmbeddedParts()) {
             String ext = pPart.getPartName().getExtension();
             if (BINARY_EXTENSION.equals(ext) || OPENXML_EXTENSION.equals(ext)) {
                 try (InputStream is = pPart.getInputStream();

diff --git a/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java b/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java
index 1cd28c626625db8b647e23e6f58cb0bcc8eb4996..23c27516990843b11c67c685f2f05322ebd39c58 100644 (file)
--- a/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java
+++ b/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java
@@ -28,7 +28,7 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem;
 
 public final class POIXMLDocumentHandler {
        protected void handlePOIXMLDocument(POIXMLDocument doc) throws Exception {
-               assertNotNull(doc.getAllEmbedds());
+               assertNotNull(doc.getAllEmbeds());
                assertNotNull(doc.getPackage());
                assertNotNull(doc.getPackagePart());
                assertNotNull(doc.getProperties());

diff --git a/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java b/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java
index 8925776b9e6ae80bcf7cb7975f73a417e1216115..1d78db0fbc7dc6b69de78c92d90cad96bf06f906 100644 (file)
--- a/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java
+++ b/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java
@@ -34,6 +34,7 @@ import org.apache.poi.openxml4j.opc.PackageAccess;
 import org.apache.poi.openxml4j.opc.PackagePart;
 import org.apache.poi.openxml4j.opc.PackageRelationship;
 import org.apache.poi.openxml4j.opc.PackageRelationshipCollection;
+import org.apache.poi.util.Removal;
 import org.apache.xmlbeans.impl.common.SystemCache;
 
 /**
@@ -153,10 +154,25 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart implements Close
      * Get the document's embedded files.
      * 
      * @return the document's embedded files
-     * 
+     *
+     * @throws OpenXML4JException if the embedded parts can't be determined
+     * @deprecated use <code>getAllEmbeddedParts</code> instead
+     */
+    @Deprecated
+    @Removal(version = "4.2")
+    public List<PackagePart> getAllEmbedds() throws OpenXML4JException {
+        return getAllEmbeddedParts();
+    }
+
+    /**
+     * Get the document's embedded files.
+     *
+     * @return the document's embedded files
+     *
      * @throws OpenXML4JException if the embedded parts can't be determined
+     * @since POI 4.0.0
      */
-    public abstract List<PackagePart> getAllEmbedds() throws OpenXML4JException;
+    public abstract List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException;
 
     protected final void load(POIXMLFactory factory) throws IOException {
         Map<PackagePart, POIXMLDocumentPart> context = new HashMap<>();

diff --git a/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java b/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java
index 57bb2fe0edbc6089ba1e3ef51fb0183874c680fb..40de1aaf72305230e0d350018a4a8b713303e0f6 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java
+++ b/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java
@@ -109,7 +109,7 @@ public class XmlVisioDocument extends POIXMLDocument {
      * Not currently implemented
      */
     @Override
-    public List<PackagePart> getAllEmbedds() {
+    public List<PackagePart> getAllEmbeddedParts() {
         return new ArrayList<>();
     }
 

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
index a57b3843acce7aa99d51722aa02b3768189112f0..c275aa98d09006072da4cc8eba683a502dd1de24 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
@@ -192,7 +192,7 @@ public class XMLSlideShow extends POIXMLDocument
      * Get the document's embedded files.
      */
     @Override
-    public List<PackagePart> getAllEmbedds() throws OpenXML4JException {
+    public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException {
         return Collections.unmodifiableList(
                 getPackage().getPartsByName(Pattern.compile("/ppt/embeddings/.*?"))
         );

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java
index 5cac511792e0d6d80d1558bc7320e41c9bed2134..842518a12a56d21cd982c74e0f2b9ed9800d1952 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java
@@ -256,7 +256,7 @@ public class XSLFSlideShow extends POIXMLDocument {
         * Get the document's embedded files.
         */
        @Override
-       public List<PackagePart> getAllEmbedds() throws OpenXML4JException {
+       public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException {
                return embedds;
        }
 

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 d2d969bb56a0e018e8e755af4ad5a76c64a6a727..284f31b2b50a421080df5ae2c0c39d11974d3a38 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -1864,7 +1864,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook {
      * Get the document's embedded files.
      */
     @Override
-    public List<PackagePart> getAllEmbedds() throws OpenXML4JException {
+    public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException {
         List<PackagePart> embedds = new LinkedList<>();
 
         for(XSSFSheet sheet : sheets){

diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
index 53693cbf5396c034ebfeb1b6be147d96bb05f5fb..26f473088ed7e26bbab2f9ffabacebba4af0f0dd 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
@@ -558,7 +558,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
      * Get the document's embedded files.
      */
     @Override
-    public List<PackagePart> getAllEmbedds() throws OpenXML4JException {
+    public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException {
         List<PackagePart> embedds = new LinkedList<>();
 
         // Get the embeddings for the workbook

diff --git a/src/ooxml/testcases/org/apache/poi/TestEmbedded.java b/src/ooxml/testcases/org/apache/poi/TestEmbedded.java
index 841e4f6cc6defeb7dbd0354a1e5a57ee15803f44..35b2642a060b2934725d02f6bd8a435657872fff 100644 (file)
--- a/src/ooxml/testcases/org/apache/poi/TestEmbedded.java
+++ b/src/ooxml/testcases/org/apache/poi/TestEmbedded.java
@@ -57,11 +57,11 @@ public class TestEmbedded extends TestCase
        }
        
        private void test(POIXMLDocument doc, int expectedCount) throws Exception {
-               assertNotNull(doc.getAllEmbedds());
-               assertEquals(expectedCount, doc.getAllEmbedds().size());
+               assertNotNull(doc.getAllEmbeddedParts());
+               assertEquals(expectedCount, doc.getAllEmbeddedParts().size());
 
-               for(int i=0; i<doc.getAllEmbedds().size(); i++) {
-                       PackagePart pp = doc.getAllEmbedds().get(i);
+               for(int i=0; i<doc.getAllEmbeddedParts().size(); i++) {
+                       PackagePart pp = doc.getAllEmbeddedParts().get(i);
                        assertNotNull(pp);
                        
                        byte[] b = IOUtils.toByteArray(pp.getInputStream());

diff --git a/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java b/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java
index d27da22bf0b17e8fd85e41403f5cdc1f58098c35..039169fa2975623f8c3cb2c96cff3e0d5abe049f 100644 (file)
--- a/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java
+++ b/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java
@@ -67,7 +67,7 @@ public final class TestPOIXMLDocument {
         }
 
         @Override
-        public List<PackagePart> getAllEmbedds() {
+        public List<PackagePart> getAllEmbeddedParts() {
             throw new RuntimeException("not supported");
         }