org.dbforms.util.external
Class IOUtil

java.lang.Object
  extended by org.dbforms.util.external.IOUtil

public final class IOUtil
extends Object

DOCUMENT ME!

Version:
$Revision: 1.5 $
Author:
$author$

Method Summary
static void bufferedCopy(InputStream input, OutputStream output)
          Deprecated. Buffering streams is actively harmful! See the class description as to why. Use copy(InputStream, OutputStream) instead.
static boolean contentEquals(InputStream input1, InputStream input2)
          Compare the contents of two Streams to determine if they are equal or not.
static void copy(byte[] input, OutputStream output)
          Copy bytes from a byte[] to an OutputStream.
static void copy(byte[] input, OutputStream output, int bufferSize)
          Copy bytes from a byte[] to an OutputStream.
static void copy(byte[] input, Writer output)
          Copy and convert bytes from a byte[] to chars on a Writer.
static void copy(byte[] input, Writer output, int bufferSize)
          Copy and convert bytes from a byte[] to chars on a Writer.
static void copy(byte[] input, Writer output, String encoding)
          Copy and convert bytes from a byte[] to chars on a Writer, using the specified encoding.
static void copy(byte[] input, Writer output, String encoding, int bufferSize)
          Copy and convert bytes from a byte[] to chars on a Writer, using the specified encoding.
static void copy(InputStream input, OutputStream output)
          Copy bytes from an InputStream to an OutputStream.
static void copy(InputStream input, OutputStream output, int bufferSize)
          Copy bytes from an InputStream to an OutputStream.
static void copy(InputStream input, Writer output)
          Copy and convert bytes from an InputStream to chars on a Writer.
static void copy(InputStream input, Writer output, int bufferSize)
          Copy and convert bytes from an InputStream to chars on a Writer.
static void copy(InputStream input, Writer output, String encoding)
          Copy and convert bytes from an InputStream to chars on a Writer, using the specified encoding.
static void copy(InputStream input, Writer output, String encoding, int bufferSize)
          Copy and convert bytes from an InputStream to chars on a Writer, using the specified encoding.
static void copy(Reader input, OutputStream output)
          Serialize chars from a Reader to bytes on an OutputStream, and flush the OutputStream.
static void copy(Reader input, OutputStream output, int bufferSize)
          Serialize chars from a Reader to bytes on an OutputStream, and flush the OutputStream.
static void copy(Reader input, Writer output)
          Copy chars from a Reader to a Writer.
static void copy(Reader input, Writer output, int bufferSize)
          Copy chars from a Reader to a Writer.
static void copy(String input, OutputStream output)
          Serialize chars from a String to bytes on an OutputStream, and flush the OutputStream.
static void copy(String input, OutputStream output, int bufferSize)
          Serialize chars from a String to bytes on an OutputStream, and flush the OutputStream.
static void copy(String input, Writer output)
          Copy chars from a String to a Writer.
static void shutdownReader(Reader input)
          Unconditionally close an Reader.
static void shutdownStream(InputStream input)
          Unconditionally close an InputStream.
static void shutdownStream(OutputStream output)
          Unconditionally close an OutputStream.
static void shutdownWriter(Writer output)
          Unconditionally close an Writer.
static byte[] toByteArray(InputStream input)
          Get the contents of an InputStream as a byte[].
static byte[] toByteArray(InputStream input, int bufferSize)
          Get the contents of an InputStream as a byte[].
static byte[] toByteArray(Reader input)
          Get the contents of a Reader as a byte[].
static byte[] toByteArray(Reader input, int bufferSize)
          Get the contents of a Reader as a byte[].
static byte[] toByteArray(String input)
          Get the contents of a String as a byte[].
static byte[] toByteArray(String input, int bufferSize)
          Get the contents of a String as a byte[].
static String toString(byte[] input)
          Get the contents of a byte[] as a String.
static String toString(byte[] input, int bufferSize)
          Get the contents of a byte[] as a String.
static String toString(byte[] input, String encoding)
          Get the contents of a byte[] as a String.
static String toString(byte[] input, String encoding, int bufferSize)
          Get the contents of a byte[] as a String.
static String toString(InputStream input)
          Get the contents of an InputStream as a String.
static String toString(InputStream input, int bufferSize)
          Get the contents of an InputStream as a String.
static String toString(InputStream input, String encoding)
          Get the contents of an InputStream as a String.
static String toString(InputStream input, String encoding, int bufferSize)
          Get the contents of an InputStream as a String.
static String toString(Reader input)
          Get the contents of a Reader as a String.
static String toString(Reader input, int bufferSize)
          Get the contents of a Reader as a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

bufferedCopy

public static void bufferedCopy(InputStream input,
                                OutputStream output)
                         throws IOException
Deprecated. Buffering streams is actively harmful! See the class description as to why. Use copy(InputStream, OutputStream) instead.

Copy bytes from an InputStream to an OutputStream, with buffering. This is equivalent to passing a BufferedInputStream and BufferedOutputStream to copy(InputStream, OutputStream), and flushing the output stream afterwards. The streams are not closed after the copy.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

contentEquals

public static boolean contentEquals(InputStream input1,
                                    InputStream input2)
                             throws IOException
Compare the contents of two Streams to determine if they are equal or not.

Parameters:
input1 - the first stream
input2 - the second stream
Returns:
true if the content of the streams are equal or they both don't exist, false otherwise
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(InputStream input,
                        OutputStream output)
                 throws IOException
Copy bytes from an InputStream to an OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(InputStream input,
                        OutputStream output,
                        int bufferSize)
                 throws IOException
Copy bytes from an InputStream to an OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(Reader input,
                        Writer output)
                 throws IOException
Copy chars from a Reader to a Writer.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(Reader input,
                        Writer output,
                        int bufferSize)
                 throws IOException
Copy chars from a Reader to a Writer.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(InputStream input,
                        Writer output)
                 throws IOException
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 - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(InputStream input,
                        Writer output,
                        int bufferSize)
                 throws IOException
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 - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(InputStream input,
                        Writer output,
                        String encoding)
                 throws IOException
Copy and convert bytes from an InputStream to chars on a Writer, using the specified encoding.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(InputStream input,
                        Writer output,
                        String encoding,
                        int bufferSize)
                 throws IOException
Copy and convert bytes from an InputStream to chars on a Writer, using the specified encoding.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(Reader input,
                        OutputStream output)
                 throws IOException
Serialize chars from a Reader to bytes on an OutputStream, and flush the OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(Reader input,
                        OutputStream output,
                        int bufferSize)
                 throws IOException
Serialize chars from a Reader to bytes on an OutputStream, and flush the OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(String input,
                        OutputStream output)
                 throws IOException
Serialize chars from a String to bytes on an OutputStream, and flush the OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(String input,
                        OutputStream output,
                        int bufferSize)
                 throws IOException
Serialize chars from a String to bytes on an OutputStream, and flush the OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(String input,
                        Writer output)
                 throws IOException
Copy chars from a String to a Writer.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(byte[] input,
                        Writer output)
                 throws IOException
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 - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(byte[] input,
                        Writer output,
                        int bufferSize)
                 throws IOException
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 - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(byte[] input,
                        Writer output,
                        String encoding)
                 throws IOException
Copy and convert bytes from a byte[] to chars on a Writer, using the specified encoding.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(byte[] input,
                        Writer output,
                        String encoding,
                        int bufferSize)
                 throws IOException
Copy and convert bytes from a byte[] to chars on a Writer, using the specified encoding.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(byte[] input,
                        OutputStream output)
                 throws IOException
Copy bytes from a byte[] to an OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

copy

public static void copy(byte[] input,
                        OutputStream output,
                        int bufferSize)
                 throws IOException
Copy bytes from a byte[] to an OutputStream.

Parameters:
input - DOCUMENT ME!
output - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Throws:
IOException - DOCUMENT ME!

shutdownReader

public static void shutdownReader(Reader input)
Unconditionally close an Reader. Equivalent to Reader.close(), except any exceptions will be ignored.

Parameters:
input - A (possibly null) Reader

shutdownStream

public static void shutdownStream(OutputStream output)
Unconditionally close an OutputStream. Equivalent to OutputStream.close(), except any exceptions will be ignored.

Parameters:
output - A (possibly null) OutputStream

shutdownStream

public static void shutdownStream(InputStream input)
Unconditionally close an InputStream. Equivalent to InputStream.close(), except any exceptions will be ignored.

Parameters:
input - A (possibly null) InputStream

shutdownWriter

public static void shutdownWriter(Writer output)
Unconditionally close an Writer. Equivalent to Writer.close(), except any exceptions will be ignored.

Parameters:
output - A (possibly null) Writer

toByteArray

public static byte[] toByteArray(InputStream input)
                          throws IOException
Get the contents of an InputStream as a byte[].

Parameters:
input - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toByteArray

public static byte[] toByteArray(InputStream input,
                                 int bufferSize)
                          throws IOException
Get the contents of an InputStream as a byte[].

Parameters:
input - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toByteArray

public static byte[] toByteArray(Reader input)
                          throws IOException
Get the contents of a Reader as a byte[].

Parameters:
input - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toByteArray

public static byte[] toByteArray(Reader input,
                                 int bufferSize)
                          throws IOException
Get the contents of a Reader as a byte[].

Parameters:
input - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toByteArray

public static byte[] toByteArray(String input)
                          throws IOException
Get the contents of a String as a byte[].

Parameters:
input - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toByteArray

public static byte[] toByteArray(String input,
                                 int bufferSize)
                          throws IOException
Get the contents of a String as a byte[].

Parameters:
input - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(InputStream input)
                       throws IOException
Get the contents of an InputStream as a String. The platform's default encoding is used for the byte-to-char conversion.

Parameters:
input - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(InputStream input,
                              int bufferSize)
                       throws IOException
Get the contents of an InputStream as a String. The platform's default encoding is used for the byte-to-char conversion.

Parameters:
input - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(InputStream input,
                              String encoding)
                       throws IOException
Get the contents of an InputStream as a String.

Parameters:
input - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(InputStream input,
                              String encoding,
                              int bufferSize)
                       throws IOException
Get the contents of an InputStream as a String.

Parameters:
input - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(Reader input)
                       throws IOException
Get the contents of a Reader as a String.

Parameters:
input - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(Reader input,
                              int bufferSize)
                       throws IOException
Get the contents of a Reader as a String.

Parameters:
input - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(byte[] input)
                       throws IOException
Get the contents of a byte[] as a String. The platform's default encoding is used for the byte-to-char conversion.

Parameters:
input - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(byte[] input,
                              int bufferSize)
                       throws IOException
Get the contents of a byte[] as a String. The platform's default encoding is used for the byte-to-char conversion.

Parameters:
input - DOCUMENT ME!
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(byte[] input,
                              String encoding)
                       throws IOException
Get the contents of a byte[] as a String.

Parameters:
input - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!

toString

public static String toString(byte[] input,
                              String encoding,
                              int bufferSize)
                       throws IOException
Get the contents of a byte[] as a String.

Parameters:
input - DOCUMENT ME!
encoding - The name of a supported character encoding. See the IANA Charset Registry for a list of valid encoding types.
bufferSize - Size of internal buffer to use.
Returns:
DOCUMENT ME!
Throws:
IOException - DOCUMENT ME!


Copyright © 2002-2006 DbForms. All Rights Reserved.