You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by fa...@apache.org on 2018/06/06 16:51:14 UTC

svn commit: r1833059 - in /poi/trunk/src: examples/src/org/apache/poi/ss/examples/ examples/src/org/apache/poi/xslf/usermodel/ examples/src/org/apache/poi/xssf/usermodel/examples/ examples/src/org/apache/poi/xwpf/usermodel/examples/ integrationtest/org...

Author: fanningpj
Date: Wed Jun  6 16:51:13 2018
New Revision: 1833059

URL: http://svn.apache.org/viewvc?rev=1833059&view=rev
Log:
[bug-62435] Rename getAllEmbedds method to getAllEmbeddedParts (getAllEmbedds is retained but deprecated)

Modified:
    poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java
    poi/trunk/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java
    poi/trunk/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java
    poi/trunk/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java
    poi/trunk/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java
    poi/trunk/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java
    poi/trunk/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java
    poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
    poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java
    poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
    poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
    poi/trunk/src/ooxml/testcases/org/apache/poi/TestEmbedded.java
    poi/trunk/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java

Modified: poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java (original)
+++ poi/trunk/src/examples/src/org/apache/poi/ss/examples/LoadEmbedded.java Wed Jun  6 16:51:13 2018
@@ -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

Modified: poi/trunk/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java (original)
+++ poi/trunk/src/examples/src/org/apache/poi/xslf/usermodel/DataExtraction.java Wed Jun  6 16:51:13 2018
@@ -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();

Modified: poi/trunk/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java (original)
+++ poi/trunk/src/examples/src/org/apache/poi/xssf/usermodel/examples/EmbeddedObjects.java Wed Jun  6 16:51:13 2018
@@ -33,7 +33,7 @@ import org.apache.poi.xwpf.usermodel.XWP
 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;

Modified: poi/trunk/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java (original)
+++ poi/trunk/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java Wed Jun  6 16:51:13 2018
@@ -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();

Modified: poi/trunk/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java (original)
+++ poi/trunk/src/integrationtest/org/apache/poi/stress/POIXMLDocumentHandler.java Wed Jun  6 16:51:13 2018
@@ -28,7 +28,7 @@ import org.apache.poi.poifs.filesystem.P
 
 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());

Modified: poi/trunk/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/ooxml/POIXMLDocument.java Wed Jun  6 16:51:13 2018
@@ -34,6 +34,7 @@ import org.apache.poi.openxml4j.opc.Pack
 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 ext
      * 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<>();

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xdgf/usermodel/XmlVisioDocument.java Wed Jun  6 16:51:13 2018
@@ -109,7 +109,7 @@ public class XmlVisioDocument extends PO
      * Not currently implemented
      */
     @Override
-    public List<PackagePart> getAllEmbedds() {
+    public List<PackagePart> getAllEmbeddedParts() {
         return new ArrayList<>();
     }
 

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XMLSlideShow.java Wed Jun  6 16:51:13 2018
@@ -192,7 +192,7 @@ public class XMLSlideShow extends POIXML
      * 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/.*?"))
         );

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFSlideShow.java Wed Jun  6 16:51:13 2018
@@ -256,7 +256,7 @@ public class XSLFSlideShow extends POIXM
 	 * Get the document's embedded files.
 	 */
 	@Override
-	public List<PackagePart> getAllEmbedds() throws OpenXML4JException {
+	public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException {
 		return embedds;
 	}
 

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java Wed Jun  6 16:51:13 2018
@@ -1864,7 +1864,7 @@ public class XSSFWorkbook extends POIXML
      * 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){

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java Wed Jun  6 16:51:13 2018
@@ -558,7 +558,7 @@ public class XWPFDocument extends POIXML
      * 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

Modified: poi/trunk/src/ooxml/testcases/org/apache/poi/TestEmbedded.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/testcases/org/apache/poi/TestEmbedded.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/testcases/org/apache/poi/TestEmbedded.java (original)
+++ poi/trunk/src/ooxml/testcases/org/apache/poi/TestEmbedded.java Wed Jun  6 16:51:13 2018
@@ -57,11 +57,11 @@ public class TestEmbedded extends TestCa
 	}
 	
 	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());

Modified: poi/trunk/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java?rev=1833059&r1=1833058&r2=1833059&view=diff
==============================================================================
--- poi/trunk/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java (original)
+++ poi/trunk/src/ooxml/testcases/org/apache/poi/ooxml/TestPOIXMLDocument.java Wed Jun  6 16:51:13 2018
@@ -67,7 +67,7 @@ public final class TestPOIXMLDocument {
         }
 
         @Override
-        public List<PackagePart> getAllEmbedds() {
+        public List<PackagePart> getAllEmbeddedParts() {
             throw new RuntimeException("not supported");
         }
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org