* the terms of the GNU General Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at your option) any later
* version.
- *
+ *
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
- *
+ *
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
* Place - Suite 330, Boston, MA 02111-1307, USA.
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
+import java.util.EventListener;
/**
* Copies input from an {@link InputStream} to an {@link OutputStream}.
- *
+ *
* @author <a href="mailto:droden@gmail.com">David Roden</a>
- * @version $Id: StreamCopier.java 428 2006-03-29 18:03:36Z bombe $
+ * @version $Id$
*/
public class StreamCopier {
/**
* Creates a new StreamCopier with the specified parameters and the default
* buffer size.
- *
+ *
* @param inputStream
* The {@link InputStream} to read from
* @param outputStream
/**
* Creates a new StreamCopier with the specified parameters and the default
* buffer size.
- *
+ *
* @param inputStream
* The {@link InputStream} to read from
* @param outputStream
* Copies the stream data. If the input stream is depleted before the
* requested number of bytes have been read an {@link EOFException} is
* thrown.
- *
+ *
* @throws EOFException
* if the input stream is depleted before the requested number
* of bytes has been read
}
/**
+ * Copies the stream data. If the input stream is depleted before the
+ * requested number of bytes have been read an {@link EOFException} is
+ * thrown.
+ *
+ * @param progressListener
+ * The progress listener (may be {@code null})
+ * @throws EOFException
+ * if the input stream is depleted before the requested number
+ * of bytes has been read
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ public void copy(ProgressListener progressListener) throws EOFException, IOException {
+ copy(inputStream, outputStream, length, bufferSize, progressListener);
+ }
+
+ /**
* Copies <code>length</code> bytes from the <code>inputStream</code> to
* the <code>outputStream</code>.
- *
+ *
* @param inputStream
* The input stream to read from
* @param outputStream
/**
* Copies <code>length</code> bytes from the <code>inputStream</code> to
+ * the <code>outputStream</code>.
+ *
+ * @param inputStream
+ * The input stream to read from
+ * @param outputStream
+ * The output stream to write to
+ * @param length
+ * The number of bytes to copy
+ * @param progressListener
+ * The progress listener (may be {@code null})
+ * @throws IOException
+ * if an I/O exception occurs
+ */
+ public static void copy(InputStream inputStream, OutputStream outputStream, long length, ProgressListener progressListener) throws IOException {
+ copy(inputStream, outputStream, length, BUFFER_SIZE, progressListener);
+ }
+
+ /**
+ * Copies <code>length</code> bytes from the <code>inputStream</code> to
* the <code>outputStream</code> using a buffer with the specified size
- *
+ *
* @param inputStream
* The input stream to read from
* @param outputStream
* if an I/O exception occurs
*/
public static void copy(InputStream inputStream, OutputStream outputStream, long length, int bufferSize) throws IOException {
+ copy(inputStream, outputStream, length, bufferSize, null);
+ }
+
+ /**
+ * Copies <code>length</code> bytes from the <code>inputStream</code> to
+ * the <code>outputStream</code> using a buffer with the specified size
+ *
+ * @param inputStream
+ * The input stream to read from
+ * @param outputStream
+ * The output stream to write to
+ * @param length
+ * The number of bytes to copy
+ * @param bufferSize
+ * The size of the copy buffer
+ * @param progressListener
+ * The progress listener (may be {@code null})
+ * @throws IOException
+ * if an I/O exception occurs
+ */
+ public static void copy(InputStream inputStream, OutputStream outputStream, long length, int bufferSize, ProgressListener progressListener) throws IOException {
long remaining = length;
byte[] buffer = new byte[bufferSize];
while (remaining > 0) {
}
outputStream.write(buffer, 0, read);
remaining -= read;
+ if (progressListener != null) {
+ progressListener.onProgress(length - remaining, length);
+ }
}
}
+ /**
+ * Interface for objects that want to be notified about the progress of a
+ * {@link StreamCopier#copy()} operation.
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
+ */
+ public static interface ProgressListener extends EventListener {
+
+ /**
+ * Notifiies a listener that a copy process made some progress.
+ *
+ * @param copied
+ * The number of bytes that have already been copied
+ * @param length
+ * The total number of bytes that will be copied
+ */
+ public void onProgress(long copied, long length);
+
+ }
+
}