2 Copyright (C) 2002, 2004 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath 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; either version 2, or (at your option)
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
40 import java
.io
.IOException
;
41 import java
.io
.ObjectInputStream
;
42 import java
.io
.ObjectOutputStream
;
43 import java
.io
.Serializable
;
44 import java
.util
.Arrays
;
45 import java
.util
.HashMap
;
46 import java
.util
.HashSet
;
52 * Maps arbitrary keys (usually Strings) to {@link Action} instances. This
53 * is used in combination with {@link InputMap}s.
55 * If a component receives an input event, this is looked up in
56 * the component's <code>InputMap</code>. The result is an object which
57 * serves as a key to the components <code>ActionMap</code>. Finally
58 * the <code>Action</code> that is stored is executed.
60 * @author Andrew Selkirk
61 * @author Michael Koch
63 public class ActionMap
64 implements Serializable
66 private static final long serialVersionUID
= -6277518704513986346L;
71 private Map actionMap
= new HashMap();
76 private ActionMap parent
;
79 * Creates a new <code>ActionMap</code> instance.
83 // Nothing to do here.
87 * Returns an action associated with an object.
89 * @param key the key of the enty
91 * @return the action associated with key, may be null
93 public Action
get(Object key
)
95 Object result
= actionMap
.get(key
);
97 if (result
== null && parent
!= null)
98 result
= parent
.get(key
);
100 return (Action
) result
;
104 * Puts a new <code>Action</code> into the <code>ActionMap</code>.
105 * If action is null an existing entry will be removed.
107 * @param key the key for the entry
108 * @param action the action.
110 public void put(Object key
, Action action
)
113 actionMap
.remove(key
);
115 actionMap
.put(key
, action
);
119 * Remove an entry from the <code>ActionMap</code>.
121 * @param key the key of the entry to remove
123 public void remove(Object key
)
125 actionMap
.remove(key
);
129 * Returns the parent of this <code>ActionMap</code>.
131 * @return the parent, may be null.
133 public ActionMap
getParent()
139 * Sets a parent for this <code>ActionMap</code>.
141 * @param parentMap the new parent
143 public void setParent(ActionMap parentMap
)
145 if (parentMap
!= this)
150 * Returns the number of entries in this <code>ActionMap</code>.
152 * @return the number of entries
156 return actionMap
.size();
160 * Clears the <code>ActionMap</code>.
168 * Returns all keys of entries in this <code>ActionMap</code>.
170 * @return an array of keys
172 public Object
[] keys()
175 return actionMap
.keySet().toArray();
180 * Returns all keys of entries in this <code>ActionMap</code>
181 * and all its parents.
183 * @return an array of keys
185 public Object
[] allKeys()
187 Set set
= new HashSet();
190 set
.addAll(Arrays
.asList(parent
.allKeys()));
192 set
.addAll(actionMap
.keySet());
194 return set
.toArray();
201 * @param stream the stream to write to
203 * @exception IOException If an error occurs
205 private void writeObject(ObjectOutputStream stream
)
214 * @param stream the stream to read from
216 * @exception ClassNotFoundException If the serialized class cannot be found
217 * @exception IOException If an error occurs
219 private void readObject(ObjectInputStream stream
)
220 throws ClassNotFoundException
, IOException