bibliothek.gui.dock.station.support
Class PlaceholderMetaMap

java.lang.Object
  extended by bibliothek.gui.dock.station.support.PlaceholderMetaMap
Direct Known Subclasses:
ConvertedPlaceholderListItem, PlaceholderList.Item

public class PlaceholderMetaMap
extends Object

A map for storing information that can be handled by a PlaceholderMap. In particular this map allows to store integers, longs, doubles, booleans and Strings only.

Author:
Benjamin Sigg

Constructor Summary
PlaceholderMetaMap()
           
 
Method Summary
 boolean contains(String key)
          Tells whether some data is stored for key.
 Object get(String key)
          Gets the data that is stored for key key.
 boolean getBoolean(String key)
          Gets the data that is stored for key key.
 double getDouble(String key)
          Gets the data that is stored for key key.
 int getInt(String key)
          Gets the data that is stored for key key.
 long getLong(String key)
          Gets the data that is stored for key key.
 String getString(String key)
          Gets the data that is stored for key key.
 String[] keys()
          Gets the keys of all the data that is stored.
 void put(String key, Object value)
          Stores an additional key-value pair.
 void putBoolean(String key, boolean value)
          Stores an additional key-value pair.
 void putInt(String key, int value)
          Stores an additional key-value pair.
 void putLong(String key, long value)
          Stores an additional key-value pair.
 void putString(String key, String value)
          Stores an additional key-value pair.
 void putValue(String key, double value)
          Stores an additional key-value pair.
 Object remove(String key)
          Removes key from this map.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlaceholderMetaMap

public PlaceholderMetaMap()
Method Detail

putInt

public void putInt(String key,
                   int value)
Stores an additional key-value pair.

Parameters:
key - the key
value - the value

putLong

public void putLong(String key,
                    long value)
Stores an additional key-value pair.

Parameters:
key - the key
value - the value

putValue

public void putValue(String key,
                     double value)
Stores an additional key-value pair.

Parameters:
key - the key
value - the value

putBoolean

public void putBoolean(String key,
                       boolean value)
Stores an additional key-value pair.

Parameters:
key - the key
value - the value

putString

public void putString(String key,
                      String value)
Stores an additional key-value pair.

Parameters:
key - the key
value - the value

put

public void put(String key,
                Object value)
Stores an additional key-value pair.

Parameters:
key - the key
value - the value

remove

public Object remove(String key)
Removes key from this map.

Parameters:
key - some key of an entry to remove
Returns:
the old value of that entry, can be null

keys

public String[] keys()
Gets the keys of all the data that is stored.

Returns:
the keys, not null

getString

public String getString(String key)
Gets the data that is stored for key key.

Parameters:
key - the key of some entry
Returns:
the data
Throws:
IllegalArgumentException - if there is nothing stored for key or if the stored object has the wrong type

getInt

public int getInt(String key)
Gets the data that is stored for key key.

Parameters:
key - the key of some entry
Returns:
the data
Throws:
IllegalArgumentException - if there is nothing stored for key or if the stored object has the wrong type

getLong

public long getLong(String key)
Gets the data that is stored for key key.

Parameters:
key - the key of some entry
Returns:
the data
Throws:
IllegalArgumentException - if there is nothing stored for key or if the stored object has the wrong type

getDouble

public double getDouble(String key)
Gets the data that is stored for key key.

Parameters:
key - the key of some entry
Returns:
the data
Throws:
IllegalArgumentException - if there is nothing stored for key or if the stored object has the wrong type

getBoolean

public boolean getBoolean(String key)
Gets the data that is stored for key key.

Parameters:
key - the key of some entry
Returns:
the data
Throws:
IllegalArgumentException - if there is nothing stored for key or if the stored object has the wrong type

get

public Object get(String key)
Gets the data that is stored for key key.

Parameters:
key - the key of some entry
Returns:
the data, can be null

contains

public boolean contains(String key)
Tells whether some data is stored for key.

Parameters:
key - the key to search
Returns:
true if data exists, false otherwise