1 /**
2 *
3 * Copyright 2003-2004 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.geronimo.kernel.repository;
18
19 /**
20 * An interface for getting notifications on the progress of file writes.
21 *
22 * @version $Rev: 399534 $ $Date: 2006-05-03 21:09:17 -0700 (Wed, 03 May 2006) $
23 */
24 public interface FileWriteMonitor {
25 /**
26 * @param fileSize If it's known ahead of time, this is the total size of
27 * the file to be written. This would typically be the
28 * case for a copy operation, for example, but not
29 * necessarily for a download. If the file size is not
30 * known, this will be set to a negative number.
31 */
32 public void writeStarted(String fileDescription, int fileSize);
33
34 /**
35 * The running count of bytes written.
36 */
37 public void writeProgress(int bytes);
38
39 /**
40 * Indicates that the write completed with the specified number
41 * of total bytes.
42 */
43 public void writeComplete(int bytes);
44 }