gate.util

Class OptionsMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<Object,Object>

gate.util.OptionsMap

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>, NavigableMap<Object,Object>, SortedMap<Object,Object>

public class OptionsMap
extends TreeMap<Object,Object>

A map that stores values as strings and provides support for converting some frequently used types to and from string.
Not very efficient as there is a lot of conversions from/to String. The conversion could happen only when loading/saving from/to a file.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
OptionsMap()

Method Summary

Modifier and Type	Method and Description
Boolean	getBoolean(Object key) If the object stored under key is a Boolean then returns its value otherwise returns false.
Boolean	getBoolean(Object key, Boolean defaultValue)
Double	getDouble(Object key) If the object stored under key is an Double then returns its value otherwise returns null.
File	getFile(Object key)
Font	getFont(Object key) If the object stored under key is a Font then returns its value otherwise returns null.
Integer	getInt(Object key) If the object stored under key is an Integer then returns its value otherwise returns null.
Integer	getInt(Object key, Integer defaultValue)
Map<String,String>	getMap(Object key) If the object stored under key is a map then returns its value otherwise returns an empty map.
LinkedHashSet<String>	getSet(Object key) If the object stored under key is a set then returns its value otherwise returns an empty set.
String	getString(Object key) If the object stored under key is a String then returns its value otherwise returns null.
Map<String,String>	getStringMap() Returns a String based view of the data.
Object	put(Object key, LinkedHashSet<String> value)
Object	put(Object key, Map<String,String> value)
Object	put(Object key, Object value) Converts the value to string using Strings.toString(Object) method and then stores it.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

OptionsMap

public OptionsMap()

Method Detail

put

public Object put(Object key,
                  Object value)

Converts the value to string using Strings.toString(Object) method and then stores it. There is get methods for values that are a String, an Integer, a Boolean, a Font, a List of String and a Map of String*String.

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class TreeMap<Object,Object>

put

public Object put(Object key,
                  LinkedHashSet<String> value)

put

public Object put(Object key,
                  Map<String,String> value)

getInt

public Integer getInt(Object key)

If the object stored under key is an Integer then returns its value otherwise returns null.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated integer

getInt

public Integer getInt(Object key,
                      Integer defaultValue)

getFile

public File getFile(Object key)

getDouble

public Double getDouble(Object key)

If the object stored under key is an Double then returns its value otherwise returns null.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated Double

getBoolean

public Boolean getBoolean(Object key)

If the object stored under key is a Boolean then returns its value otherwise returns false.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated boolean

getBoolean

public Boolean getBoolean(Object key,
                          Boolean defaultValue)

getString

public String getString(Object key)

If the object stored under key is a String then returns its value otherwise returns null.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated string

getFont

public Font getFont(Object key)

If the object stored under key is a Font then returns its value otherwise returns null.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated font

getSet

public LinkedHashSet<String> getSet(Object key)

If the object stored under key is a set then returns its value otherwise returns an empty set.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated linked hash set

getMap

public Map<String,String> getMap(Object key)

If the object stored under key is a map then returns its value otherwise returns an empty map.

Parameters:

key - key associated to the value to retrieve

Returns:

the associated map

getStringMap

public Map<String,String> getStringMap()

Returns a String based view of the data. All the keys and values are stored as strings in the underlying map, but because we want to allow the addition of Object, which is then converted to a String, we aren't ourselves typed as String to String.