View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package org.xnap.transfer;
21  
22  import org.xnap.event.ListListener;
23  
24  /***
25   * Defines the requirements for container classes that manages multiple
26   * {@link Transfer} objects.
27   */
28  public interface TransferContainer {
29  
30      //--- Constant(s) ---
31  
32      //--- Method(s) ---
33  
34      /***
35       * Adds <code>listener</code> to the list of
36       * listeners. <code>Listener</code> should be notified whenever a
37       * child Transfer is added or removed.  
38       */
39      void addListListener(ListListener listener);
40  
41  	/***
42  	 * Asks the transfer to clear all its done children.
43  	 */
44  	void clearDone();
45  
46      /***
47       * Removed <code>listener</code> from the list of listeners.
48       */
49      void removeListListener(ListListener listener);
50  
51      /***
52       * Returns an array of all child {@link Transfer} objects.
53       */
54      Transfer[] getChildren();
55  
56  }