com.purplehillsbooks.streams

Class StreamHelper

java.lang.Object

com.purplehillsbooks.streams.StreamHelper

public class StreamHelper
extends java.lang.Object

Quite simply: there are a number of patterns that get written over and over when using streams, and so these methods are just a common colection of shortcuts Author: Keith Swenson Copyright: Keith Swenson, all rights reserved License: This code is made available under the GNU Lesser GPL license.

Constructor Summary

Constructors

Constructor and Description
StreamHelper()

Method Summary

Modifier and Type	Method and Description
static void	copyFileToFile(java.io.File inFile, java.io.File outFile) This is a convenience routine to copy the contents of one file to another file.
static void	copyFileToOutput(java.io.File file, java.io.OutputStream os) Given an output stream, copyFileToOutput will read the contents of a file and stream those contents to the output stream until the entire file is sent.
static void	copyFileToWriter(java.io.File file, java.io.Writer w, java.lang.String fileEncoding) Given an output Writer object, copyFileToWriter will read the contents of a file converting bytes to characters according to specified encoding, and stream those characters to the Reader until the entire file is sent.
static void	copyInputToOutput(java.io.InputStream is, java.io.OutputStream os) copyInputToOutput will read bytes from the input stream, and send them to the output stream until the input stream is exhausted.
static void	copyReaderToFile(java.io.Reader r, java.io.File file, java.lang.String encoding) copyReaderToUTF8File will read the input Reader to the end, and write the contents to the designated file using specified encoding, overwriting any existing file that might be there.
static void	copyReaderToUTF8File(java.io.Reader r, java.io.File file) copyReaderToUTF8File will read the input Reader to the end, and write the contents to the designated file using UTF-8 encoding, overwriting any existing file that might be there.
static void	copyReaderToWriter(java.io.Reader r, java.io.Writer w) copyReaderToWriter will read character from the Reader, and send them to the Writer until the Reader is exhausted.
static void	copyStreamToFile(java.io.InputStream is, java.io.File file) copyStreamToFile will read the input stream to the end, and write the contents to the designated file.
static void	copyUTF8FileToWriter(java.io.File file, java.io.Writer w) Given an output Writer object, copyUTF8FileToWriter will read the contents of a file converting bytes to characters according to UTF-8 encoding, and stream those characters to the Reader until the entire file is sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamHelper

public StreamHelper()

Method Detail

copyReaderToWriter

public static void copyReaderToWriter(java.io.Reader r,
                                      java.io.Writer w)
                               throws java.lang.Exception

copyReaderToWriter will read character from the Reader, and send them to the Writer until the Reader is exhausted.

Throws:

java.lang.Exception

copyInputToOutput

public static void copyInputToOutput(java.io.InputStream is,
                                     java.io.OutputStream os)
                              throws java.lang.Exception

copyInputToOutput will read bytes from the input stream, and send them to the output stream until the input stream is exhausted.

Throws:

java.lang.Exception

copyFileToOutput

public static void copyFileToOutput(java.io.File file,
                                    java.io.OutputStream os)
                             throws java.lang.Exception

Given an output stream, copyFileToOutput will read the contents of a file and stream those contents to the output stream until the entire file is sent.

Throws:

java.lang.Exception

copyFileToWriter

public static void copyFileToWriter(java.io.File file,
                                    java.io.Writer w,
                                    java.lang.String fileEncoding)
                             throws java.lang.Exception

Given an output Writer object, copyFileToWriter will read the contents of a file converting bytes to characters according to specified encoding, and stream those characters to the Reader until the entire file is sent.

Throws:

java.lang.Exception

copyUTF8FileToWriter

public static void copyUTF8FileToWriter(java.io.File file,
                                        java.io.Writer w)
                                 throws java.lang.Exception

Given an output Writer object, copyUTF8FileToWriter will read the contents of a file converting bytes to characters according to UTF-8 encoding, and stream those characters to the Reader until the entire file is sent.

Throws:

java.lang.Exception

copyStreamToFile

public static void copyStreamToFile(java.io.InputStream is,
                                    java.io.File file)
                             throws java.lang.Exception

copyStreamToFile will read the input stream to the end, and write the contents to the designated file. Bytes are read and bytes are written the resulting file is in whatever encoding that the source stream is. The contents are written first to a temporary file, and then that file is renamed to destination file. If the process is interrupted in the middle of the copy, the temporary file might remain.

Throws:

java.lang.Exception

copyReaderToUTF8File

public static void copyReaderToUTF8File(java.io.Reader r,
                                        java.io.File file)
                                 throws java.lang.Exception

copyReaderToUTF8File will read the input Reader to the end, and write the contents to the designated file using UTF-8 encoding, overwriting any existing file that might be there. The contents are written first to a temporary file, and then that file is renamed to destination file. If the process is interrupted in the middle of the copy, the temporary file might remain.

Throws:

java.lang.Exception

copyReaderToFile

public static void copyReaderToFile(java.io.Reader r,
                                    java.io.File file,
                                    java.lang.String encoding)
                             throws java.lang.Exception

copyReaderToUTF8File will read the input Reader to the end, and write the contents to the designated file using specified encoding, overwriting any existing file that might be there. The contents are written first to a temporary file, and then that file is renamed to destination file. If the process is interrupted in the middle of the copy, the temporary file might remain.

Throws:

java.lang.Exception

copyFileToFile

public static void copyFileToFile(java.io.File inFile,
                                  java.io.File outFile)
                           throws java.lang.Exception

This is a convenience routine to copy the contents of one file to another file. It does do by reading all the bytes from one, and writing the butes to another. There is no restriction on where those files might exist, just as long as they can be opened and read/writen to. The contents are written first to a temporary file, and then that file is renamed to destination file. If the process is interrupted in the middle of the copy, the temporary file might remain.

Throws:

java.lang.Exception