View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  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.commons.fileupload;
18  
19  
20  /**
21   * The {@link ProgressListener} may be used to display a progress bar
22   * or do stuff like that.
23   */
24  public interface ProgressListener {
25      /** Updates the listeners status information.
26       * @param pBytesRead The total number of bytes, which have been read
27       *   so far.
28       * @param pContentLength The total number of bytes, which are being
29       *   read. May be -1, if this number is unknown.
30       * @param pItems The number of the field, which is currently being
31       *   read. (0 = no item so far, 1 = first item is being read, ...)
32       */
33      void update(long pBytesRead, long pContentLength, int pItems);
34  }