001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.geronimo.kernel.repository;
018    
019    /**
020     * An interface for getting notifications on the progress of file writes.
021     *
022     * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
023     */
024    public interface FileWriteMonitor {
025        /**
026         * @param fileSize If it's known ahead of time, this is the total size of
027         *                 the file to be written.  This would typically be the
028         *                 case for a copy operation, for example, but not
029         *                 necessarily for a download.  If the file size is not
030         *                 known, this will be set to a negative number.
031         */
032        public void writeStarted(String fileDescription, int fileSize);
033    
034        /**
035         * The running count of bytes written.
036         */
037        public void writeProgress(int bytes);
038    
039        /**
040         * Indicates that the write completed with the specified number
041         * of total bytes.
042         */
043        public void writeComplete(int bytes);
044    }