From: PJ Fanning Date: Wed, 6 Jun 2018 16:51:13 +0000 (+0000) Subject: [bug-62435] Rename getAllEmbedds method to getAllEmbeddedParts (getAllEmbedds is... X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=53bb443e647c31f666462c8733d81e5f9f8a7d67;p=poi.git [bug-62435] Rename getAllEmbedds method to getAllEmbeddedParts (getAllEmbedds is retained but deprecated) 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 2ad0347f7b..4fd640ca70 100644 --- 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 5716679dbb..82e5705f7d 100644 --- 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 b760acac03..1931af7557 100644 --- 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 ef57d79995..c21f595d13 100644 --- 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 embeddedDocs = this.doc.getAllEmbedds(); + List 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 1cd28c6266..23c2751699 100644 --- 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 8925776b9e..1d78db0fbc 100644 --- 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 getAllEmbeddedParts instead + */ + @Deprecated + @Removal(version = "4.2") + public List 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 getAllEmbedds() throws OpenXML4JException; + public abstract List getAllEmbeddedParts() throws OpenXML4JException; protected final void load(POIXMLFactory factory) throws IOException { Map 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 57bb2fe0ed..40de1aaf72 100644 --- 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 getAllEmbedds() { + public List 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 a57b3843ac..c275aa98d0 100644 --- 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 getAllEmbedds() throws OpenXML4JException { + public List 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 5cac511792..842518a12a 100644 --- 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 getAllEmbedds() throws OpenXML4JException { + public List 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 d2d969bb56..284f31b2b5 100644 --- 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 getAllEmbedds() throws OpenXML4JException { + public List getAllEmbeddedParts() throws OpenXML4JException { List 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 53693cbf53..26f473088e 100644 --- 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 getAllEmbedds() throws OpenXML4JException { + public List getAllEmbeddedParts() throws OpenXML4JException { List 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 841e4f6cc6..35b2642a06 100644 --- 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 getAllEmbedds() { + public List getAllEmbeddedParts() { throw new RuntimeException("not supported"); }