PDFBOX-6032: refactor duplicate logic and switch to CustomFactory

PDFBOX-6032: change test comment

Author: ilgoo.kim

…model/graphics/image/DefaultFactory.java …dmodel/graphics/image/CustomFactory.javapdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/DefaultFactory.java renamed to pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/CustomFactory.java pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/DefaultFactory.java renamed to pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/CustomFactory.java

@@ -5,6 +5,6 @@
 import org.apache.pdfbox.pdmodel.PDDocument;
 
 @FunctionalInterface
-public interface DefaultFactory {
+public interface CustomFactory {
 	PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray) throws IOException;
 }

pdfbox/src/main/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObject.java

@@ -340,47 +340,7 @@ public static PDImageXObject createFromFileByContent(File file, PDDocument doc)
      */
     public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray, String name) throws IOException
     {
-        FileType fileType = FileTypeDetector.detectFileType(byteArray);
-        if (fileType == null)
-        {
-            throw new IllegalArgumentException("Image type not supported: " + name);
-        }
-
-        if (fileType == FileType.JPEG)
-        {
-            return JPEGFactory.createFromByteArray(document, byteArray);
-        }
-        if (fileType == FileType.PNG)
-        {
-            // Try to directly convert the image without recoding it.
-            PDImageXObject image = PNGConverter.convertPNGImage(document, byteArray);
-            if (image != null)
-            {
-                return image;
-            }
-        }
-        if (fileType == FileType.TIFF)
-        {
-            try
-            {
-                return CCITTFactory.createFromByteArray(document, byteArray);
-            }
-            catch (IOException ex)
-            {
-                LOG.debug("Reading as TIFF failed, setting fileType to PNG", ex);
-                // Plan B: try reading with ImageIO
-                // common exception:
-                // First image in tiff is not CCITT T4 or T6 compressed
-                fileType = FileType.PNG;
-            }
-        }
-        if (fileType == FileType.BMP || fileType == FileType.GIF || fileType == FileType.PNG)
-        {
-            ByteArrayInputStream bais = new ByteArrayInputStream(byteArray);
-            BufferedImage bim = ImageIO.read(bais);
-            return LosslessFactory.createFromImage(document, bim);
-        }
-        throw new IllegalArgumentException("Image type " + fileType + " not supported: " + name);
+        return createFromByteArray(document, byteArray, name, null);
     }
 
     /**
@@ -391,20 +351,16 @@ public static PDImageXObject createFromByteArray(PDDocument document, byte[] byt
      * @param document the document that shall use this PDImageXObject.
      * @param byteArray bytes from an image file.
      * @param name name of image file for exception messages, can be null.
-     * @param defaultFactory optional factory used to handle BMP, GIF, or fallback cases 
+     * @param customFactory optional factory used to handle BMP, GIF, or fallback cases 
      *                       (e.g., for PNG or TIFF). If {@code null}, this method delegates to
      *                       {@link #createFromByteArray(PDDocument, byte[], String)}.
      * @return a PDImageXObject.
      * @throws IOException if there is an error when reading the file or creating the
      * PDImageXObject.
      * @throws IllegalArgumentException if the image type is not supported.
      */
-    public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray, String name, DefaultFactory defaultFactory) throws IOException
+    public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray, String name, CustomFactory customFactory) throws IOException
     {
-        if (defaultFactory == null) {
-            return createFromByteArray(document, byteArray, name);
-        }
-        
         FileType fileType = FileTypeDetector.detectFileType(byteArray);
         if (fileType == null)
         {
@@ -441,7 +397,16 @@ public static PDImageXObject createFromByteArray(PDDocument document, byte[] byt
         }
         if (fileType == FileType.BMP || fileType == FileType.GIF || fileType == FileType.PNG)
         {
-            return defaultFactory.createFromByteArray(document, byteArray);
+            if (customFactory != null)
+            {
+                return customFactory.createFromByteArray(document, byteArray);
+            }
+            else 
+            {
+                ByteArrayInputStream bais = new ByteArrayInputStream(byteArray);
+                BufferedImage bim = ImageIO.read(bais);
+                return LosslessFactory.createFromImage(document, bim);
+            }
         }
         throw new IllegalArgumentException("Image type " + fileType + " not supported: " + name);
     }

pdfbox/src/test/java/org/apache/pdfbox/pdmodel/graphics/image/PDImageXObjectTest.java

@@ -130,29 +130,16 @@ void testCreateFromByteArray() throws IOException, URISyntaxException
     }
 
     /**
-     * Test of createFromByteArray method with DefaultFactory parameter, of class PDImageXObject.
+     * Test of createFromByteArray method with CustomFactory parameter, of class PDImageXObject.
      * @throws java.io.IOException
      * @throws java.net.URISyntaxException
      */
     @Test
-    void testCreateFromByteArrayWithDefaultFactory() throws IOException, URISyntaxException
+    void testCreateFromByteArrayWithCustomFactory() throws IOException, URISyntaxException
     {
-        testCompareCreatedFromByteArrayWithCreatedByDefaultFactory("gif.gif");
-        testCompareCreatedFromByteArrayWithCreatedByDefaultFactory("gif-1bit-transparent.gif");
-        testCompareCreatedFromByteArrayWithCreatedByDefaultFactory("lzw.tif");
-    }
-
-    /**
-     * Test of createFromByteArray method with null DefaultFactory parameter, of class PDImageXObject.
-     * @throws java.io.IOException
-     * @throws java.net.URISyntaxException
-     */
-    @Test
-    void testCreateFromByteArrayWithNullDefaultFactory() throws IOException, URISyntaxException
-    {
-        testCompareCreatedFromByteArrayWithCreatedByNullDefaultFactory("gif.gif");
-        testCompareCreatedFromByteArrayWithCreatedByNullDefaultFactory("gif-1bit-transparent.gif");
-        testCompareCreatedFromByteArrayWithCreatedByNullDefaultFactory("lzw.tif");
+        testCompareCreatedFromByteArrayWithCreatedByCustomFactory("gif.gif");
+        testCompareCreatedFromByteArrayWithCreatedByCustomFactory("gif-1bit-transparent.gif");
+        testCompareCreatedFromByteArrayWithCreatedByCustomFactory("lzw.tif");
     }
 
     private void testCompareCreatedFileByExtensionWithCreatedByLosslessFactory(String filename)
@@ -348,7 +335,7 @@ private void testCompareCreatedFromByteArrayWithCreatedByJPEGFactory(String file
         }
     }
 
-    private void testCompareCreatedFromByteArrayWithCreatedByDefaultFactory(String filename)
+    private void testCompareCreatedFromByteArrayWithCreatedByCustomFactory(String filename)
             throws IOException, URISyntaxException
     {
         try (PDDocument doc = new PDDocument())
@@ -357,9 +344,9 @@ private void testCompareCreatedFromByteArrayWithCreatedByDefaultFactory(String f
             InputStream in = new FileInputStream(file);
             byte[] byteArray = in.readAllBytes();
 
-            DefaultFactory defaultFactory = this::alphaFlattenedJPEGFactory;
+            CustomFactory customFactory = this::alphaFlattenedJPEGFactory;
 
-            PDImageXObject image = PDImageXObject.createFromByteArray(doc, byteArray, filename, defaultFactory);
+            PDImageXObject image = PDImageXObject.createFromByteArray(doc, byteArray, filename, customFactory);
 
             PDImageXObject expectedImage = alphaFlattenedJPEGFactory(doc, byteArray);
 
@@ -368,28 +355,6 @@ private void testCompareCreatedFromByteArrayWithCreatedByDefaultFactory(String f
         }
     }
 
-    private void testCompareCreatedFromByteArrayWithCreatedByNullDefaultFactory(String filename)
-        throws IOException, URISyntaxException
-    {
-        try (PDDocument doc = new PDDocument())
-        {
-            File file = new File(PDImageXObjectTest.class.getResource(filename).toURI());
-            InputStream in = new FileInputStream(file);
-            byte[] byteArray = in.readAllBytes();
-
-            DefaultFactory defaultFactory = null;
-
-            PDImageXObject image = PDImageXObject.createFromByteArray(doc, byteArray, filename, defaultFactory);
-
-            ByteArrayInputStream bais = new ByteArrayInputStream(byteArray);
-            BufferedImage bim = ImageIO.read(bais);
-            PDImageXObject expectedImage = LosslessFactory.createFromImage(doc, bim);
-
-            assertEquals(expectedImage.getSuffix(), image.getSuffix());
-            checkIdentARGB(image.getImage(), expectedImage.getImage());
-        }
-    }
-
     private void checkIdentARGB(BufferedImage expectedImage, BufferedImage actualImage)
     {
         String errMsg = "";