View Javadoc

1   // TransferListener.java - 
2   // $Id: TransferListener.java,v 1.3 2006/02/20 04:52:11 sjardine Exp $
3   //
4   // Copyright 1999, 2000 Joe Phillips <jaiger@innovationsw.com>
5   // Copyright 2001, 2002 Innovation Software Group, LLC - http://www.innovationsw.com
6   //
7   // This library is free software; you can redistribute it and/or
8   // modify it under the terms of the GNU Library General Public
9   // License as published by the Free Software Foundation; either
10  // version 2 of the License, or (at your option) any later version.
11  //
12  // This library is distributed in the hope that it will be useful,
13  // but WITHOUT ANY WARRANTY; without even the implied warranty of
14  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  // Library General Public License for more details.
16  //
17  // You should have received a copy of the GNU Library General Public
18  // License along with this library; if not, write to the Free
19  // Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  //
21  package gnu.inet.ftp;
22  
23  import java.util.EventListener;
24  
25  /***
26   * This describes the interface used to get transfer status events.
27   */
28  public interface TransferListener extends EventListener {
29  
30      /***
31       * Indicates the data transfer has begun.
32       */
33      void transferStarted();
34  
35      /***
36       * Indicates the data transfer has completed.
37       */
38      void transferCompleted();
39  
40      /***
41       * Indicates some data has been transfered.
42       * 
43       * @param amount
44       *                the amount of data transfered since transferStarted() was
45       *                called
46       */
47      void transfered(long amount);
48  
49      /***
50       * Indicates some error occurred during transfer.
51       */
52      void transferFailed();
53  
54  }