Package org.apache.pivot.wtk
Class Action.NamedActionDictionary
- java.lang.Object
-
- org.apache.pivot.wtk.Action.NamedActionDictionary
-
- All Implemented Interfaces:
java.lang.Iterable<java.lang.String>
,Dictionary<java.lang.String,Action>
- Enclosing class:
- Action
public static final class Action.NamedActionDictionary extends java.lang.Object implements Dictionary<java.lang.String,Action>, java.lang.Iterable<java.lang.String>
Action dictionary implementation.We wrap the underlying
Map<>
implementation so that only a few methods are available for use.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Dictionary
Dictionary.Pair<K,V>
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsKey(java.lang.String actionName)
Tests the existence of a key in the dictionary.Action
get(java.lang.String actionName)
Retrieves the value for the given key.java.util.Iterator<java.lang.String>
iterator()
Action
put(java.lang.String actionName, Action action)
Sets the value of the given key, creating a new entry or replacing the existing value.Action
remove(java.lang.String actionName)
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
-
Methods inherited from interface org.apache.pivot.collections.Dictionary
containsAny, copy, getBoolean, getBoolean, getColor, getFirst, getFont, getInt, getInt, getString, getString, putAll
-
-
-
-
Method Detail
-
get
public Action get(java.lang.String actionName)
Description copied from interface:Dictionary
Retrieves the value for the given key.- Specified by:
get
in interfaceDictionary<java.lang.String,Action>
- Parameters:
actionName
- 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. UseDictionary.containsKey(K)
to distinguish between these two cases.
-
put
public Action put(java.lang.String actionName, Action action)
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 interfaceDictionary<java.lang.String,Action>
- Parameters:
actionName
- The key whose value is to be set.action
- The value to be associated with the given key.- Returns:
- The value previously associated with the key.
-
remove
public Action remove(java.lang.String actionName)
Description copied from interface:Dictionary
Removes a key/value pair from the map.- Specified by:
remove
in interfaceDictionary<java.lang.String,Action>
- Parameters:
actionName
- The key whose mapping is to be removed.- Returns:
- The value that was removed.
-
containsKey
public boolean containsKey(java.lang.String actionName)
Description copied from interface:Dictionary
Tests the existence of a key in the dictionary.- Specified by:
containsKey
in interfaceDictionary<java.lang.String,Action>
- Parameters:
actionName
- The key whose presence in the dictionary is to be tested.- Returns:
true
if the key exists in the dictionary;false
, otherwise.
-
iterator
public java.util.Iterator<java.lang.String> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.String>
-
-