KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > ristretto > io > StreamUtils


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is Ristretto Mail API.
15  *
16  * The Initial Developers of the Original Code are
17  * Timo Stich and Frederik Dietz.
18  * Portions created by the Initial Developers are Copyright (C) 2004
19  * All Rights Reserved.
20  *
21  * Contributor(s):
22  *
23  * Alternatively, the contents of this file may be used under the terms of
24  * either the GNU General Public License Version 2 or later (the "GPL"), or
25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26  * in which case the provisions of the GPL or the LGPL are applicable instead
27  * of those above. If you wish to allow use of your version of this file only
28  * under the terms of either the GPL or the LGPL, and not to allow others to
29  * use your version of this file under the terms of the MPL, indicate your
30  * decision by deleting the provisions above and replace them with the notice
31  * and other provisions required by the GPL or the LGPL. If you do not delete
32  * the provisions above, a recipient may use your version of this file under
33  * the terms of any one of the MPL, the GPL or the LGPL.
34  *
35  * ***** END LICENSE BLOCK ***** */

36 package org.columba.ristretto.io;
37
38 import java.io.ByteArrayInputStream JavaDoc;
39 import java.io.ByteArrayOutputStream JavaDoc;
40 import java.io.IOException JavaDoc;
41 import java.io.InputStream JavaDoc;
42 import java.io.OutputStream JavaDoc;
43 import java.nio.ByteBuffer JavaDoc;
44 import java.nio.charset.Charset JavaDoc;
45 import java.util.logging.Logger JavaDoc;
46
47 /**
48  * Utility methods to copy, clone and convert
49  * a stream to a String.
50  *
51  * @author tstich
52  *
53  */

54 public class StreamUtils {
55     /** JDK 1.4+ logging framework logger, used for logging. */
56     private static final Logger JavaDoc LOG = Logger
57             .getLogger("org.columba.ristretto.message.io");
58     
59     
60     private static final int BUFFERSIZE = 8000;
61
62     /**
63      * Copies all bytes from an InputStream to an OutputStream. The Bufsize should be 8000 bytes or 16000 bytes. This
64      * is platform dependend. A higher number of bytes to read on block, blocks the operation for a greater time.
65      * @param _isInput InputStream from wihch the bytes are to copied.
66      * @param _osOutput OutputStream in which the bytes are copied.
67      * @param _iBufSize The Buffer size. How many bytes on block are should be copied.
68      * @return Number of bytes which are copied.
69      * @throws IOException
70      */

71     public static long streamCopy(InputStream JavaDoc _isInput, OutputStream JavaDoc _osOutput, int _iBufSize) throws IOException JavaDoc {
72         byte[] _aBuffer = new byte[_iBufSize];
73         int _iBytesRead;
74         long _lBytesCopied = 0;
75         while ((_iBytesRead = _isInput.read(_aBuffer)) > 0 ) {
76             _osOutput.write(_aBuffer, 0, _iBytesRead);
77             _lBytesCopied += _iBytesRead;
78             _osOutput.flush();
79         }
80         LOG.finer("Copied " + _lBytesCopied + "bytes");
81         
82         return _lBytesCopied;
83     }
84
85     /**
86      * Copies all bytes from an InputStream to an OutputStream. The Bufsize is set to 8000 bytes.
87      * @param _isInput InputStream from wihch the bytes are to copied.
88      * @param _osOutput OutputStream in which the bytes are copied.
89      * @return Number of bytes which are copied.
90      * @throws IOException
91      */

92     public static long streamCopy(InputStream JavaDoc _isInput, OutputStream JavaDoc _osOutput ) throws IOException JavaDoc {
93         return streamCopy( _isInput, _osOutput, BUFFERSIZE );
94     }
95
96     
97     /**
98      * Reads a InputStream into a StringBuffer.
99      * This method is 8bit safe.
100      *
101      * @param in the InputStream to read from
102      * @return the interpreted InputStream
103      * @throws IOException
104      */

105     public static StringBuffer JavaDoc readInString( InputStream JavaDoc in ) throws IOException JavaDoc {
106         StringBuffer JavaDoc result = new StringBuffer JavaDoc(in.available());
107         int read = in.read();
108
109         while (read > 0) {
110             result.append((char) read);
111             read = in.read();
112         }
113
114         in.close();
115         
116         return result;
117     }
118     
119     /** Copies all bytes from the given InputStream in a intern ByteArrayOutputStream and returnes a new InputStream
120      * with all bytes from the ByteArrayOutputStream. The data are real copied so this methods "clones" the given
121      * Inputstream and gives back a new InputStream with same Data.
122      * @param from InputStream from which all datas are to copy
123      * @return a new InputStream with all data from the given InputStream
124      * @throws IOException
125      */

126     public static InputStream JavaDoc streamClone(InputStream JavaDoc from) throws IOException JavaDoc {
127         ByteArrayOutputStream JavaDoc out = new ByteArrayOutputStream JavaDoc();
128          streamCopy(from, out);
129          return new ByteArrayInputStream JavaDoc(out.toByteArray());
130     }
131
132 }
133
Popular Tags