XGC-148: add xmlgraphics.util.io.IOUtils

Author: vlsi

examples/java/image/writer/ImageWriterExample2.java

@@ -26,11 +26,11 @@
 import java.io.IOException;
 import java.io.OutputStream;
 
-import org.apache.commons.io.IOUtils;
 import org.apache.xmlgraphics.image.writer.ImageWriter;
 import org.apache.xmlgraphics.image.writer.ImageWriterParams;
 import org.apache.xmlgraphics.image.writer.ImageWriterRegistry;
 import org.apache.xmlgraphics.image.writer.MultiImageWriter;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 public class ImageWriterExample2 extends ImageWriterExample1 {
 

src/main/java/org/apache/xmlgraphics/image/loader/impl/AbstractImageSessionContext.java

@@ -48,6 +48,7 @@
 import org.apache.xmlgraphics.image.loader.util.ImageUtil;
 import org.apache.xmlgraphics.image.loader.util.SoftMapCache;
 import org.apache.xmlgraphics.io.XmlSourceUtil;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 /**
  * Abstract base class for classes implementing ImageSessionContext. This class provides all the
@@ -132,14 +133,7 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl
                     try {
                         return method.invoke(iin, args);
                     } finally {
-                        InputStream in = this.in;
-                        if (in != null) {
-                            try {
-                                in.close();
-                            } catch (IOException ignore) {
-                                // ignore
-                            }
-                        }
+                        IOUtils.closeQuietly(this.in);
                         this.in = null;
                     }
                 } else {
@@ -336,11 +330,7 @@ public Source createSource(Source source, String uri) {
 
                 if (directFileAccess) {
                     //Close as the file is reopened in a more optimal way
-                    try {
-                        in.close();
-                    } catch (IOException ignore) {
-                        // ignore
-                    }
+                    IOUtils.closeQuietly(in);
                     try {
                         // We let the OS' file system cache do the caching for us
                         // --> lower Java memory consumption, probably no speed loss

src/main/java/org/apache/xmlgraphics/image/loader/impl/ImageRawStream.java

@@ -24,11 +24,10 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 
-import org.apache.commons.io.IOUtils;
-
 import org.apache.xmlgraphics.image.loader.ImageFlavor;
 import org.apache.xmlgraphics.image.loader.ImageInfo;
 import org.apache.xmlgraphics.image.loader.MimeEnabledImageFlavor;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 /**
  * This class is an implementation of the Image interface exposing an InputStream for loading the
@@ -163,14 +162,7 @@ public synchronized InputStream createInputStream() {
         }
 
         public synchronized void close() {
-            InputStream in = this.in;
-            if (in != null) {
-                try {
-                    in.close();
-                } catch (IOException ignore) {
-                    // ignore
-                }
-            }
+            IOUtils.closeQuietly(this.in);
             this.in = null;
         }
 

src/main/java/org/apache/xmlgraphics/image/loader/pipeline/ImageProviderPipeline.java

@@ -26,7 +26,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.apache.commons.io.IOUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -41,6 +40,7 @@
 import org.apache.xmlgraphics.image.loader.spi.ImageImplRegistry;
 import org.apache.xmlgraphics.image.loader.spi.ImageLoader;
 import org.apache.xmlgraphics.image.loader.util.Penalty;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 /**
  * Represents a pipeline of ImageConverters with an ImageLoader at the beginning of the

src/main/java/org/apache/xmlgraphics/io/XmlSourceUtil.java

@@ -19,7 +19,6 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
-import java.io.Closeable;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Reader;
@@ -36,6 +35,7 @@
 import org.apache.xmlgraphics.image.loader.ImageSource;
 import org.apache.xmlgraphics.image.loader.util.ImageInputStreamAdapter;
 import org.apache.xmlgraphics.image.loader.util.ImageUtil;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 /**
  * A utility class for handling {@link Source} objects, more specficially the streams that back
@@ -136,7 +136,7 @@ public static void removeStreams(Source src) {
     public static void closeQuietly(Source src) {
         if (src instanceof StreamSource) {
             StreamSource streamSource = (StreamSource) src;
-            closeQuietly(streamSource.getReader());
+            IOUtils.closeQuietly(streamSource.getReader());
         } else if (src instanceof ImageSource) {
             if (ImageUtil.getImageInputStream(src) != null) {
                 try {
@@ -148,24 +148,13 @@ public static void closeQuietly(Source src) {
         } else if (src instanceof SAXSource) {
             InputSource is = ((SAXSource) src).getInputSource();
             if (is != null) {
-                closeQuietly(is.getByteStream());
-                closeQuietly(is.getCharacterStream());
+                IOUtils.closeQuietly(is.getByteStream());
+                IOUtils.closeQuietly(is.getCharacterStream());
             }
         }
         removeStreams(src);
     }
 
-    private static void closeQuietly(Closeable in) {
-        if (in == null) {
-            return;
-        }
-        try {
-            in.close();
-        } catch (IOException ignore) {
-            // ignore
-        }
-    }
-
     /**
      * Indicates whether the Source object has an InputStream instance.
      * @param src the Source object

src/main/java/org/apache/xmlgraphics/ps/PSFontUtils.java

@@ -24,10 +24,10 @@
 import java.io.InputStream;
 
 import org.apache.commons.io.EndianUtils;
-import org.apache.commons.io.IOUtils;
 
 import org.apache.xmlgraphics.fonts.Glyphs;
 import org.apache.xmlgraphics.util.io.ASCIIHexOutputStream;
+import org.apache.xmlgraphics.util.io.IOUtils;
 import org.apache.xmlgraphics.util.io.SubInputStream;
 
 // CSOFF: HideUtilityClassConstructor

src/main/java/org/apache/xmlgraphics/ps/PSGenerator.java

@@ -32,15 +32,14 @@
 
 import javax.xml.transform.Source;
 
-import org.apache.commons.io.IOUtils;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 import org.apache.xmlgraphics.java2d.color.ColorUtil;
 import org.apache.xmlgraphics.java2d.color.ColorWithAlternatives;
 import org.apache.xmlgraphics.ps.dsc.ResourceTracker;
 import org.apache.xmlgraphics.util.DoubleFormatUtil;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 /**
  * This class is used to output PostScript code to an OutputStream. This class assumes that
@@ -842,7 +841,7 @@ public boolean embedIdentityH() throws IOException {
             resTracker.registerNeededResource(getProcsetCIDInitResource());
             writeDSCComment(DSCConstants.BEGIN_DOCUMENT, IDENTITY_H);
             try (InputStream cmap = PSGenerator.class.getResourceAsStream(IDENTITY_H)) {
-                IOUtils.copyLarge(cmap, out);
+                IOUtils.copy(cmap, out);
             }
             writeDSCComment(DSCConstants.END_DOCUMENT);
             resTracker.registerSuppliedResource(getIdentityHCMapResource());

src/main/java/org/apache/xmlgraphics/ps/PSImageUtils.java

@@ -35,11 +35,10 @@
 import java.io.OutputStream;
 import java.util.Arrays;
 
-import org.apache.commons.io.IOUtils;
-
 import org.apache.xmlgraphics.util.io.ASCII85OutputStream;
 import org.apache.xmlgraphics.util.io.Finalizable;
 import org.apache.xmlgraphics.util.io.FlateEncodeOutputStream;
+import org.apache.xmlgraphics.util.io.IOUtils;
 import org.apache.xmlgraphics.util.io.RunLengthEncodeOutputStream;
 
 // CSOFF: HideUtilityClassConstructor

src/main/java/org/apache/xmlgraphics/util/io/IOUtils.java

@@ -0,0 +1,110 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.xmlgraphics.util.io;
+
+import java.io.ByteArrayOutputStream;
+import java.io.Closeable;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Reader;
+
+/**
+ * Utility class providing convenience methods for I/O operations.
+ */
+public final class IOUtils {
+    private IOUtils() {
+    }
+
+    /**
+     * Copies all bytes from the provided input stream to the given output stream.
+     * The method operates using a buffer and is useful for transferring data
+     * between streams without modifying the contents.
+     *
+     * @param input  the {@code InputStream} to read data from, must not be {@code null}
+     * @param output the {@code OutputStream} to write data to, must not be {@code null}
+     * @return the total number of bytes copied
+     * @throws IOException if an I/O error occurs during reading or writing
+     */
+    public static long copy(InputStream input, OutputStream output) throws IOException {
+        // TODO replace with input.transferTo(output) when Java 9+ is acceptable
+        byte[] buffer = new byte[4096];
+        long count = 0;
+        int n;
+        while ((n = input.read(buffer)) != -1) {
+            output.write(buffer, 0, n);
+            count += n;
+        }
+        return count;
+    }
+
+     /**
+      * Converts the contents of the provided InputStream into a byte array.
+      * This method reads all the data from the InputStream and writes it into
+      * a ByteArrayOutputStream, which is then converted to a byte array.
+      *
+      * @param input the InputStream to read data from, must not be {@code null}
+      * @return a byte array containing all the data read from the InputStream
+      * @throws IOException if an I/O error occurs while reading from the InputStream
+      */
+     public static byte[] toByteArray(InputStream input) throws IOException {
+         // TODO replace with InputStream.readAllBytes when Java 9+ is acceptable
+         ByteArrayOutputStream output = new ByteArrayOutputStream();
+         copy(input, output);
+         return output.toByteArray();
+    }
+
+    /**
+     * Converts the contents of the provided Reader into a String.
+     * This method reads characters from the Reader into a buffer and then
+     * appends them to a StringBuilder, which is returned as a String.
+     *
+     * @param reader the Reader to read data from, must not be null
+     * @return a String containing all the characters read from the Reader
+     * @throws IOException if an I/O error occurs while reading from the Reader
+     */
+    public static String toString(Reader reader) throws IOException {
+        StringBuilder sb = new StringBuilder();
+        char [] buf = new char[128];
+        int n;
+        while ((n = reader.read(buf)) > 0) {
+            sb.append(buf, 0, n);
+        }
+        return sb.toString();
+    }
+
+    /**
+     * Closes a {@code Closeable} object quietly, suppressing any exceptions
+     * that might occur during the close operation. If the provided {@code Closeable}
+     * is {@code null}, this method does nothing.
+     *
+     * @param closeable the {@code Closeable} object to close; may be {@code null}.
+     */
+    public static void closeQuietly(Closeable closeable) {
+        if (closeable == null) {
+            return;
+        }
+        try {
+            closeable.close();
+        } catch (Exception ignore) {
+            //Ignore
+        }
+    }
+}

src/main/java/org/apache/xmlgraphics/util/uri/DataURLUtil.java

@@ -24,10 +24,9 @@
 import java.io.StringWriter;
 import java.io.Writer;
 
-import org.apache.commons.io.IOUtils;
-
 import org.apache.xmlgraphics.util.WriterOutputStream;
 import org.apache.xmlgraphics.util.io.Base64EncodeStream;
+import org.apache.xmlgraphics.util.io.IOUtils;
 
 /**
  * Utility classes for generating RFC 2397 data URLs.
@@ -64,9 +63,9 @@ public static void writeDataURL(InputStream in, String mediatype, Writer writer)
             writer.write(mediatype);
         }
         writer.write(";base64,");
-        Base64EncodeStream out = new Base64EncodeStream(
-                new WriterOutputStream(writer, "US-ASCII"), false);
-        IOUtils.copy(in, out);
-        out.close();
+        try (Base64EncodeStream out = new Base64EncodeStream(
+                new WriterOutputStream(writer, "US-ASCII"), false)) {
+            IOUtils.copy(in, out);
+        }
     }
 }