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.event;
21  
22  import java.util.EventObject;
23  
24  /***
25   * An event that characterizes a change in a list.
26   */
27  public class ListEvent extends EventObject
28  { 
29  
30      //--- Constant(s) ---
31  
32      public static final int ITEM_ADDED = 1;
33      public static final int ITEM_REMOVED = 2;
34  
35      //--- Data Field(s) ---
36      
37      Object item;
38      int id;
39  
40      //--- Constructor(s) ---
41  
42      /***
43       * Constructs a list event.
44       *
45       * @param source the object on which the event initially occurred
46       * @param id <code>ITEM_ADDED</code> or <code>ITEM_REMOVED</code>
47       * @param item the item that was added or removed
48       */
49      public ListEvent(Object source, int id, Object item)
50      {
51  		super(source);
52  
53  		this.id = id;
54  		this.item = item;
55      }
56  
57      //--- Method(s) ---
58  
59      /***
60       * Returns the item that was added or removed.
61       */
62      public Object getItem()
63      {
64  		return item;
65      }
66  
67      /***
68       * Returns <code>ITEM_ADDED</code> or <code>ITEM_REMOVED</code>.
69       */
70      public int getID()
71      {
72  		return id;
73      }
74  
75  }