CopyUtils (Commons IO 2.5)
Date: 2016-12-01

org.apache.commons.io

## Class CopyUtils

- java.lang.Object
- - org.apache.commons.io.CopyUtils

- Deprecated.
  Use IOUtils. Will be removed in 2.0. Methods renamed to IOUtils.write() or IOUtils.copy(). Null handling behaviour changed in IOUtils (null data does not throw NullPointerException).

      @Deprecated
      public class CopyUtils
      extends java.lang.Object

  This class provides static utility methods for buffered copying between sources (`InputStream`, `Reader`, `String` and `byte[]`) and destinations (`OutputStream`, `Writer`, `String` and `byte[]`).

  Unless otherwise noted, these `copy` methods do not flush or close the streams. Often doing so would require making non-portable assumptions about the streams' origin and further use. This means that both streams' `close()` methods must be called after copying. if one omits this step, then the stream resources (sockets, file descriptors) are released when the associated Stream is garbage-collected. It is not a good idea to rely on this mechanism. For a good overview of the distinction between "memory management" and "resource management", see this UnixReview article.

  For byte-to-char methods, a `copy` variant allows the encoding to be selected (otherwise the platform default is used). We would like to encourage you to always specify the encoding because relying on the platform default can lead to unexpected results.

  We don't provide special variants for the `copy` methods that let you specify the buffer size because in modern VMs the impact on speed seems to be minimal. We're using a default buffer size of 4 KB.

  The `copy` methods use an internal buffer when copying. It is therefore advisable not to deliberately wrap the stream arguments to the `copy` methods in `Buffered*` streams. For example, don't do the following:

        copy( new BufferedInputStream( in ), new BufferedOutputStream( out ) );

  The rationale is as follows:

  Imagine that an InputStream's read() is a very expensive operation, which would usually suggest wrapping in a BufferedInputStream. The BufferedInputStream works by issuing infrequent `InputStream.read(byte[] b, int off, int len)` requests on the underlying InputStream, to fill an internal buffer, from which further `read` requests can inexpensively get their data (until the buffer runs out).

  However, the `copy` methods do the same thing, keeping an internal buffer, populated by `InputStream.read(byte[] b, int off, int len)` requests. Having two buffers (or three if the destination stream is also buffered) is pointless, and the unnecessary buffer management hurts performance slightly (about 3%, according to some simple experiments).

  Behold, intrepid explorers; a map of this class:

             Method      Input               Output          Dependency
             ------      -----               ------          -------
       1     copy        InputStream         OutputStream    (primitive)
       2     copy        Reader              Writer          (primitive)

       3     copy        InputStream         Writer          2

       4     copy        Reader              OutputStream    2

       5     copy        String              OutputStream    2
       6     copy        String              Writer          (trivial)

       7     copy        byte[]              Writer          3
       8     copy        byte[]              OutputStream    (trivial)

  Note that only the first two methods shuffle bytes; the rest use these two, or (if possible) copy using native Java copy methods. As there are method variants to specify the encoding, each row may correspond to up to 2 methods.

  Origin of code: Excalibur.

  Version:
    $Id: CopyUtils.java 1680650 2015-05-20 18:36:40Z britter $

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `private static int` | `DEFAULT_BUFFER_SIZE` Deprecated. The default size of the buffer.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `CopyUtils()` Deprecated. Instances should NOT be constructed in standard programming.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `copy(byte[] input, java.io.OutputStream output)` Deprecated. Copy bytes from a `byte[]` to an `OutputStream`.
    `static void` | `copy(byte[] input, java.io.Writer output)` Deprecated. 2.5 use `copy(byte[], Writer, String)` instead
    `static void` | `copy(byte[] input, java.io.Writer output, java.lang.String encoding)` Deprecated. Copy and convert bytes from a `byte[]` to chars on a `Writer`, using the specified encoding.
    `static int` | `copy(java.io.InputStream input, java.io.OutputStream output)` Deprecated. Copy bytes from an `InputStream` to an `OutputStream`.
    `static void` | `copy(java.io.InputStream input, java.io.Writer output)` Deprecated. 2.5 use `copy(InputStream, Writer, String)` instead
    `static void` | `copy(java.io.InputStream input, java.io.Writer output, java.lang.String encoding)` Deprecated. Copy and convert bytes from an `InputStream` to chars on a `Writer`, using the specified encoding.
    `static void` | `copy(java.io.Reader input, java.io.OutputStream output)` Deprecated. 2.5 use `copy(Reader, OutputStream, String)` instead
    `static void` | `copy(java.io.Reader input, java.io.OutputStream output, java.lang.String encoding)` Deprecated. Serialize chars from a `Reader` to bytes on an `OutputStream`, and flush the `OutputStream`.
    `static int` | `copy(java.io.Reader input, java.io.Writer output)` Deprecated. Copy chars from a `Reader` to a `Writer`.
    `static void` | `copy(java.lang.String input, java.io.OutputStream output)` Deprecated. 2.5 use `copy(String, OutputStream, String)` instead
    `static void` | `copy(java.lang.String input, java.io.OutputStream output, java.lang.String encoding)` Deprecated. Serialize chars from a `String` to bytes on an `OutputStream`, and flush the `OutputStream`.
    `static void` | `copy(java.lang.String input, java.io.Writer output)` Deprecated. Copy chars from a `String` to a `Writer`.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### DEFAULT_BUFFER_SIZE

          private static final int DEFAULT_BUFFER_SIZE

      Deprecated.
      The default size of the buffer.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### CopyUtils

          public CopyUtils()

      Deprecated.
      Instances should NOT be constructed in standard programming.

  - ### Method Detail

    - #### copy

          public static void copy(byte[] input,
                  java.io.OutputStream output)
                           throws java.io.IOException

      Deprecated.
      Copy bytes from a `byte[]` to an `OutputStream`.
      Parameters:
        `input` - the byte array to read from
        `output` - the `OutputStream` to write to
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          @Deprecated
          public static void copy(byte[] input,
                             java.io.Writer output)
                           throws java.io.IOException

      Deprecated. 2.5 use `copy(byte[], Writer, String)` instead
      Copy and convert bytes from a `byte[]` to chars on a `Writer`. The platform's default encoding is used for the byte-to-char conversion.
      Parameters:
        `input` - the byte array to read from
        `output` - the `Writer` to write to
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          public static void copy(byte[] input,
                  java.io.Writer output,
                  java.lang.String encoding)
                           throws java.io.IOException

      Deprecated.
      Copy and convert bytes from a `byte[]` to chars on a `Writer`, using the specified encoding.
      Parameters:
        `input` - the byte array to read from
        `output` - the `Writer` to write to
        `encoding` - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          public static int copy(java.io.InputStream input,
                 java.io.OutputStream output)
                          throws java.io.IOException

      Deprecated.
      Copy bytes from an `InputStream` to an `OutputStream`.
      Parameters:
        `input` - the `InputStream` to read from
        `output` - the `OutputStream` to write to
      Returns:
        the number of bytes copied
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          public static int copy(java.io.Reader input,
                 java.io.Writer output)
                          throws java.io.IOException

      Deprecated.
      Copy chars from a `Reader` to a `Writer`.
      Parameters:
        `input` - the `Reader` to read from
        `output` - the `Writer` to write to
      Returns:
        the number of characters copied
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          @Deprecated
          public static void copy(java.io.InputStream input,
                             java.io.Writer output)
                           throws java.io.IOException

      Deprecated. 2.5 use `copy(InputStream, Writer, String)` instead
      Copy and convert bytes from an `InputStream` to chars on a `Writer`. The platform's default encoding is used for the byte-to-char conversion.
      Parameters:
        `input` - the `InputStream` to read from
        `output` - the `Writer` to write to
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          public static void copy(java.io.InputStream input,
                  java.io.Writer output,
                  java.lang.String encoding)
                           throws java.io.IOException

      Deprecated.
      Copy and convert bytes from an `InputStream` to chars on a `Writer`, using the specified encoding.
      Parameters:
        `input` - the `InputStream` to read from
        `output` - the `Writer` to write to
        `encoding` - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          @Deprecated
          public static void copy(java.io.Reader input,
                             java.io.OutputStream output)
                           throws java.io.IOException

      Deprecated. 2.5 use `copy(Reader, OutputStream, String)` instead
      Serialize chars from a `Reader` to bytes on an `OutputStream`, and flush the `OutputStream`. Uses the default platform encoding.
      Parameters:
        `input` - the `Reader` to read from
        `output` - the `OutputStream` to write to
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          public static void copy(java.io.Reader input,
                  java.io.OutputStream output,
                  java.lang.String encoding)
                           throws java.io.IOException

      Deprecated.
      Serialize chars from a `Reader` to bytes on an `OutputStream`, and flush the `OutputStream`.
      Parameters:
        `input` - the `Reader` to read from
        `output` - the `OutputStream` to write to
        `encoding` - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
      Throws:
        `java.io.IOException` - In case of an I/O problem
      Since:
        2.5

    - #### copy

          @Deprecated
          public static void copy(java.lang.String input,
                             java.io.OutputStream output)
                           throws java.io.IOException

      Deprecated. 2.5 use `copy(String, OutputStream, String)` instead
      Serialize chars from a `String` to bytes on an `OutputStream`, and flush the `OutputStream`. Uses the platform default encoding.
      Parameters:
        `input` - the `String` to read from
        `output` - the `OutputStream` to write to
      Throws:
        `java.io.IOException` - In case of an I/O problem

    - #### copy

          public static void copy(java.lang.String input,
                  java.io.OutputStream output,
                  java.lang.String encoding)
                           throws java.io.IOException

      Deprecated.
      Serialize chars from a `String` to bytes on an `OutputStream`, and flush the `OutputStream`.
      Parameters:
        `input` - the `String` to read from
        `output` - the `OutputStream` to write to
        `encoding` - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
      Throws:
        `java.io.IOException` - In case of an I/O problem
      Since:
        2.5

    - #### copy

          public static void copy(java.lang.String input,
                  java.io.Writer output)
                           throws java.io.IOException

      Deprecated.
      Copy chars from a `String` to a `Writer`.
      Parameters:
        `input` - the `String` to read from
        `output` - the `Writer` to write to
      Throws:
        `java.io.IOException` - In case of an I/O problem

Copyright (c) 2002-2016 Apache Software Foundation