pivot.wtk
Class Window.ActionDictionary

java.lang.Object
  extended by pivot.wtk.Window.ActionDictionary
All Implemented Interfaces:
Dictionary<Keyboard.KeyStroke,Action>
Enclosing class:
Window

public final class Window.ActionDictionary
extends java.lang.Object
implements Dictionary<Keyboard.KeyStroke,Action>

Action dictionary implementation.

Author:
gbrown

Method Summary
 boolean containsKey(Keyboard.KeyStroke key)
          Tests the existence of a key in the dictionary.
 Action get(Keyboard.KeyStroke key)
          Retrieves the value for the given key.
 boolean isEmpty()
          Tests the emptiness of the dictionary.
 Action put(Keyboard.KeyStroke key, Action value)
          Sets the value of the given key, creating a new entry or replacing the existing value.
 Action remove(Keyboard.KeyStroke key)
          Removes a key/value pair from the map.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public Action get(Keyboard.KeyStroke key)
Description copied from interface: Dictionary
Retrieves the value for the given key.

Specified by:
get in interface Dictionary<Keyboard.KeyStroke,Action>
Parameters:
key - The key whose value is to be returned.
Returns:
The value corresponding to key, or null if the key does not exist. Will also return null if the key refers to a null value. Use containsKey() to distinguish between these two cases.

put

public Action put(Keyboard.KeyStroke key,
                  Action value)
Description copied from interface: Dictionary
Sets the value of the given key, creating a new entry or replacing the existing value.

Specified by:
put in interface Dictionary<Keyboard.KeyStroke,Action>
Parameters:
key - The key whose value is to be set.
value - The value to be associated with the given key.

remove

public Action remove(Keyboard.KeyStroke key)
Description copied from interface: Dictionary
Removes a key/value pair from the map.

Specified by:
remove in interface Dictionary<Keyboard.KeyStroke,Action>
Parameters:
key - The key whose mapping is to be removed.
Returns:
The value that was removed.

containsKey

public boolean containsKey(Keyboard.KeyStroke key)
Description copied from interface: Dictionary
Tests the existence of a key in the dictionary.

Specified by:
containsKey in interface Dictionary<Keyboard.KeyStroke,Action>
Parameters:
key - The key whose presence in the dictionary is to be tested.
Returns:
true if the key exists in the dictionary; false, otherwise.

isEmpty

public boolean isEmpty()
Description copied from interface: Dictionary
Tests the emptiness of the dictionary.

Specified by:
isEmpty in interface Dictionary<Keyboard.KeyStroke,Action>
Returns:
true if the dictionary contains no keys; false, otherwise.