libjava/javax/swing/ActionMap.java

   1 /* ActionMap.java --
   2    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   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)
   9 any later version.
  10
  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.
  15
  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  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
  24 combination.
  25
  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. */
  37
  38 package javax.swing;
  39
  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;
  47 import java.util.Map;
  48 import java.util.Set;
  49
  50
  51 /**
  52  * @author Andrew Selkirk
  53  * @author Michael Koch
  54  */
  55 public class ActionMap
  56   implements Serializable
  57 {
  58   private static final long serialVersionUID = -6277518704513986346L;
  59
  60   /**
  61    * actionMap
  62    */
  63   private Map actionMap = new HashMap();
  64
  65   /**
  66    * parent
  67    */
  68   private ActionMap parent;
  69
  70   /**
  71    * Creates a new <code>ActionMap</code> instance.
  72    */
  73   public ActionMap()
  74   {
  75   }
  76
  77   /**
  78    * Returns an action associated with an object.
  79    *
  80    * @param key the key of the enty
  81    *
  82    * @return the action associated with key, may be null
  83    */
  84   public Action get(Object key)
  85   {
  86     Object result = actionMap.get(key);
  87
  88     if (result == null && parent != null)
  89       result = parent.get(key);
  90
  91     return (Action) result;
  92   }
  93
  94   /**
  95    * Puts a new <code>Action</code> into the <code>ActionMap</code>.
  96    * If action is null an existing entry will be removed.
  97    *
  98    * @param key the key for the entry
  99    * @param action the action.
 100    */
 101   public void put(Object key, Action action)
 102   {
 103     if (action == null)
 104       actionMap.remove(key);
 105     else
 106       actionMap.put(key, action);
 107   }
 108
 109   /**
 110    * Remove an entry from the <code>ActionMap</code>.
 111    *
 112    * @param key the key of the entry to remove
 113    */
 114   public void remove(Object key)
 115   {
 116     actionMap.remove(key);
 117   }
 118
 119   /**
 120    * Returns the parent of this <code>ActionMap</code>.
 121    *
 122    * @return the parent, may be null.
 123    */
 124   public ActionMap getParent()
 125   {
 126     return parent;
 127   }
 128
 129   /**
 130    * Sets a parent for this <code>ActionMap</code>.
 131    *
 132    * @param parentMap the new parent
 133    */
 134   public void setParent(ActionMap parentMap)
 135   {
 136     parent = parentMap;
 137   }
 138
 139   /**
 140    * Returns the number of entries in this <code>ActionMap</code>.
 141    *
 142    * @return the number of entries
 143    */
 144   public int size()
 145   {
 146     return actionMap.size();
 147   }
 148
 149   /**
 150    * Clears the <code>ActionMap</code>.
 151    */
 152   public void clear()
 153   {
 154     actionMap.clear();
 155   }
 156
 157   /**
 158    * Returns all keys of entries in this <code>ActionMap</code>.
 159    *
 160    * @return an array of keys
 161    */
 162   public Object[] keys()
 163   {
 164     return actionMap.keySet().toArray();
 165   }
 166
 167   /**
 168    * Returns all keys of entries in this <code>ActionMap</code>
 169    * and all its parents.
 170    *
 171    * @return an array of keys
 172    */
 173   public Object[] allKeys()
 174   {
 175     Set set = new HashSet();
 176
 177     if (parent != null)
 178       set.addAll(Arrays.asList(parent.allKeys()));
 179
 180     set.addAll(actionMap.keySet());
 181     return set.toArray();
 182   }
 183
 184   /**
 185    * writeObject
 186    *
 187    * @param stream the stream to write to
 188    *
 189    * @exception IOException If an error occurs
 190    */
 191   private void writeObject(ObjectOutputStream stream)
 192     throws IOException
 193   {
 194     // TODO
 195   }
 196
 197   /**
 198    * readObject
 199    *
 200    * @param stream the stream to read from
 201    *
 202    * @exception ClassNotFoundException If the serialized class cannot be found
 203    * @exception IOException If an error occurs
 204    */
 205   private void readObject(ObjectInputStream stream)
 206     throws ClassNotFoundException, IOException
 207   {
 208     // TODO
 209   }
 210 }