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 "SMS Library for the Java platform".
15 *
16 * The Initial Developer of the Original Code is Markus Eriksson.
17 * Portions created by the Initial Developer are Copyright (C) 2002
18 * the Initial Developer. All Rights Reserved.
19 *
20 * Contributor(s):
21 *
22 * Alternatively, the contents of this file may be used under the terms of
23 * either the GNU General Public License Version 2 or later (the "GPL"), or
24 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
25 * in which case the provisions of the GPL or the LGPL are applicable instead
26 * of those above. If you wish to allow use of your version of this file only
27 * under the terms of either the GPL or the LGPL, and not to allow others to
28 * use your version of this file under the terms of the MPL, indicate your
29 * decision by deleting the provisions above and replace them with the notice
30 * and other provisions required by the GPL or the LGPL. If you do not delete
31 * the provisions above, a recipient may use your version of this file under
32 * the terms of any one of the MPL, the GPL or the LGPL.
33 *
34 * ***** END LICENSE BLOCK ***** */
35 package org.marre.util;
36
37 import java.io.IOException;
38 import java.io.InputStream;
39 import java.io.OutputStream;
40
41 /***
42 * Contains various utiity functions related to io operations.
43 *
44 * @author Markus
45 * @version $Id: IOUtil.java,v 1.1 2005/04/07 19:58:36 c95men Exp $
46 */
47 public final class IOUtil
48 {
49 /***
50 * The default buffer size to use for the copy method.
51 */
52 private static final int DEFAULT_COPY_SIZE = 1024 * 8;
53
54 /***
55 * This class isn't intended to be instantiated.
56 */
57 private IOUtil()
58 {
59 /* Empty */
60 }
61
62 /***
63 * Copy data from in to out using the workbuff as temporary storage.
64 *
65 * @param in stream to read from
66 * @param out stream to write to
67 * @param workbuff buffer to use as temporary storage while copying
68 * @return number of bytes copied
69 * @throws IOException if an I/O error occurs
70 */
71 public static int copy(InputStream in, OutputStream out, byte[] workbuff)
72 throws IOException
73 {
74 int bytescopied = 0;
75 int bytesread = 0;
76
77 while ((bytesread = in.read(workbuff)) != -1)
78 {
79 out.write(workbuff, 0, bytesread);
80 bytescopied += bytesread;
81 }
82
83 return bytescopied;
84 }
85
86 /***
87 * Copy data from in to out using a temporary buffer of workbuffsize bytes.
88 *
89 * @param in stream to read from
90 * @param out stream to write to
91 * @param workbuffsize how large the work buffer should be
92 * @return number of bytes copied
93 * @throws IOException if an I/O error occurs
94 */
95 public static int copy(InputStream in, OutputStream out, int workbuffsize)
96 throws IOException
97 {
98 return IOUtil.copy(in, out, new byte[workbuffsize]);
99 }
100
101 /***
102 * Copy data from in to out using a default temporary buffer.
103 *
104 * @param in stream to read from
105 * @param out stream to write to
106 * @return number of bytes copied
107 * @throws IOException if an I/O error occurs
108 */
109 public static int copy(InputStream in, OutputStream out)
110 throws IOException
111 {
112 return IOUtil.copy(in, out, new byte[DEFAULT_COPY_SIZE]);
113 }
114 }