Add char[] methods to CopyUtils

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@140594 13f79535-47bb-0310-9956-ffa450edef68

Author: Stephen Colebourne

src/java/org/apache/commons/io/CopyUtils.java

@@ -16,6 +16,7 @@
 package org.apache.commons.io;
 
 import java.io.ByteArrayInputStream;
+import java.io.CharArrayReader;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -86,6 +87,9 @@
  *
  * 7     copy        byte[]              Writer          3
  * 8     copy        byte[]              OutputStream    (trivial)
+ *
+ * 9     copy        char[]              OutputStream    4
+ * 10    copy        char[]              Writer          (trivial)
  * </pre>
  *
  * <p>Note that only the first two methods shuffle bytes; the rest use these
@@ -99,7 +103,7 @@
  * @author Jeff Turner
  * @author Matthew Hawthorne
  * @author Stephen Colebourne
- * @version $Id: CopyUtils.java,v 1.7 2004/07/31 09:52:09 scolebourne Exp $
+ * @version $Id: CopyUtils.java,v 1.8 2004/07/31 10:40:47 scolebourne Exp $
  */
 public class CopyUtils {
 
@@ -118,7 +122,7 @@ public CopyUtils() {}
     /**
      * Copy bytes from a <code>byte[]</code> to an <code>OutputStream</code>.
      * 
-     * @param input  the byte array to read from
+     * @param input  the byte array to read from, do not modify during output
      * @param output  the <code>OutputStream</code> to write to
      * @throws NullPointerException if the input or output is null
      * @throws IOException if an I/O error occurs
@@ -130,8 +134,10 @@ public static void copy(byte[] input, OutputStream output) throws IOException {
     /**
      * Copy bytes from a <code>byte[]</code> to chars on a <code>Writer</code>
      * using the default character encoding of the platform.
+     * <p>
+     * This method uses {@link ByteArrayInputStream} and {@link InputStreamReader}.
      * 
-     * @param input  the byte array to read from
+     * @param input  the byte array to read from, do not modify during output
      * @param output  the <code>Writer</code> to write to
      * @throws NullPointerException if the input or output is null
      * @throws IOException if an I/O error occurs
@@ -147,8 +153,10 @@ public static void copy(byte[] input, Writer output) throws IOException {
      * <p>
      * Character encoding names can be found at
      * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
+     * <p>
+     * This method uses {@link ByteArrayInputStream} and {@link InputStreamReader}.
      * 
-     * @param input  the byte array to read from
+     * @param input  the byte array to read from, do not modify during output
      * @param output  the <code>Writer</code> to write to
      * @param encoding  the encoding to use, null means platform default
      * @throws NullPointerException if the input or output is null
@@ -184,6 +192,8 @@ public static int copy(InputStream input, OutputStream output) throws IOExceptio
     /**
      * Copy bytes from an <code>InputStream</code> to chars on a <code>Writer</code>
      * using the default character encoding of the platform.
+     * <p>
+     * This method uses {@link InputStreamReader}.
      * 
      * @param input  the <code>InputStream</code> to read from
      * @param output  the <code>Writer</code> to write to
@@ -201,6 +211,8 @@ public static void copy(InputStream input, Writer output) throws IOException {
      * <p>
      * Character encoding names can be found at
      * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
+     * <p>
+     * This method uses {@link InputStreamReader}.
      * 
      * @param input  the <code>InputStream</code> to read from
      * @param output  the <code>Writer</code> to write to
@@ -217,6 +229,58 @@ public static void copy(InputStream input, Writer output, String encoding) throw
         }
     }
 
+    // from char[]
+    //-----------------------------------------------------------------------
+    /**
+     * Copy chars from a <code>char[]</code> to a <code>Writer</code>
+     * using the default character encoding of the platform.
+     * <p>
+     * This method uses {@link CharArrayReader}.
+     * 
+     * @param input  the char array to read from, do not modify during output
+     * @param output  the <code>Writer</code> to write to
+     * @throws NullPointerException if the input or output is null
+     * @throws IOException if an I/O error occurs
+     */
+    public static void copy(char[] input, Writer output) throws IOException {
+        output.write(input);
+    }
+
+    /**
+     * Copy chars from a <code>char[]</code> to bytes on an <code>OutputStream</code>.
+     * <p>
+     * This method uses {@link CharArrayReader} and {@link OutputStreamWriter}.
+     * 
+     * @param input  the char array to read from, do not modify during output
+     * @param output  the <code>OutputStream</code> to write to
+     * @throws NullPointerException if the input or output is null
+     * @throws IOException if an I/O error occurs
+     */
+    public static void copy(char[] input, OutputStream output) throws IOException {
+        CharArrayReader in = new CharArrayReader(input);
+        copy(in, output);
+    }
+
+    /**
+     * Copy chars from a <code>char[]</code> to bytes on an <code>OutputStream</code>
+     * using the specified character encoding.
+     * <p>
+     * Character encoding names can be found at
+     * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
+     * <p>
+     * This method uses {@link CharArrayReader} and {@link OutputStreamWriter}.
+     * 
+     * @param input  the char array to read from, do not modify during output
+     * @param output  the <code>OutputStream</code> to write to
+     * @param encoding  the encoding to use, null means platform default
+     * @throws NullPointerException if the input or output is null
+     * @throws IOException if an I/O error occurs
+     */
+    public static void copy(char[] input, OutputStream output, String encoding) throws IOException {
+        CharArrayReader in = new CharArrayReader(input);
+        copy(in, output, encoding);
+    }
+
     // from Reader
     //-----------------------------------------------------------------------
     /**
@@ -244,6 +308,8 @@ public static int copy(Reader input, Writer output) throws IOException {
      * using the default character encoding of the platform, and calling flush.
      * <p>
      * Due to the implementation of OutputStreamWriter, this method performs a flush.
+     * <p>
+     * This method uses {@link OutputStreamWriter}.
      * 
      * @param input  the <code>Reader</code> to read from
      * @param output  the <code>OutputStream</code> to write to
@@ -265,6 +331,8 @@ public static void copy(Reader input, OutputStream output) throws IOException {
      * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
      * <p>
      * Due to the implementation of OutputStreamWriter, this method performs a flush.
+     * <p>
+     * This method uses {@link OutputStreamWriter}.
      * 
      * @param input  the <code>Reader</code> to read from
      * @param output  the <code>OutputStream</code> to write to
@@ -302,6 +370,8 @@ public static void copy(String input, Writer output) throws IOException {
      * using the default character encoding of the platform, and calling flush.
      * <p>
      * Due to the implementation of OutputStreamWriter, this method performs a flush.
+     * <p>
+     * This method uses {@link StringReader} and {@link OutputStreamWriter}.
      * 
      * @param input  the <code>String</code> to read from
      * @param output  the <code>OutputStream</code> to write to
@@ -324,6 +394,8 @@ public static void copy(String input, OutputStream output) throws IOException {
      * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
      * <p>
      * Due to the implementation of OutputStreamWriter, this method performs a flush.
+     * <p>
+     * This method uses {@link StringReader} and {@link OutputStreamWriter}.
      * 
      * @param input  the <code>String</code> to read from
      * @param output  the <code>OutputStream</code> to write to