KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > plugin > java > map > MapClearAction


1 /*====================================================================
2
3 Objectweb Explorer Framework
4 Copyright (C) 2000-2005 INRIA - USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or 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 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Philippe Merle, Jerome Moroy.
23 Contributor(s): ______________________________________.
24
25 ====================================================================
26 $Id: MapClearAction.java,v 1.2 2005/07/05 09:23:38 moroy Exp $
27 ====================================================================*/
28
29 package org.objectweb.util.explorer.plugin.java.map;
30
31 import org.objectweb.util.explorer.api.MenuItem;
32 import org.objectweb.util.explorer.api.MenuItemTreeView;
33 import org.objectweb.util.explorer.api.TreeView;
34
35 /**
36  * This action clears all the elements of a <code>java.util.Map</code> object.
37  * A <code>UnsupportedOperationException</code> may be thrown if the implementation
38  * of the map doesn't supported the requested operation.
39  *
40  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
41  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
42  *
43  * @version 0.1
44  */
45 public class MapClearAction
46   implements MenuItem
47 {
48
49     //==================================================================
50 //
51 // No internal state.
52 //
53 //==================================================================
54
55     //==================================================================
56 //
57 // No constructor.
58 //
59 //==================================================================
60
61     //==================================================================
62 //
63 // No internal method.
64 //
65 //==================================================================
66
67     //==================================================================
68 //
69 // Public methods for MenuItem.
70 //
71 //==================================================================
72
73     /**
74      * This item is enabled only if the map contains at least one entry.
75      */
76     public int getStatus(TreeView treeView)
77     {
78         // Obtains the selected map.
79 java.util.Map JavaDoc map = (java.util.Map JavaDoc)treeView.getSelectedObject();
80
81         // Item enabled if this map contains at least one entry.
82 if (map.size()>0)
83             return MenuItem.ENABLED_STATUS;
84         return MenuItem.DISABLED_STATUS;
85     }
86
87     /**
88      * Removes all the mappings from this map.
89      */
90     public void actionPerformed(MenuItemTreeView treeView)
91     throws Exception JavaDoc
92     {
93         // Obtains the selected map.
94 java.util.Map JavaDoc map = (java.util.Map JavaDoc)treeView.getSelectedObject();
95         
96         // Removes all entries from this map.
97 map.clear();
98     }
99
100 }
Popular Tags