Class: Dictionary

Members

private,constantKEY_PREFIX

Prefix for keys in internal MAP object, for avoiding overwrite of existing Object properties/functions

privatekeyList

This list contains the "keys" of all current entries in map.

privatemap

"map" for the dictionary

Methods

clear()

tools/dictionary.js, line 262

Remove all entries from the dictionary.

NOTE that this may execute rather slowly, with O(n).

containsKey(key){Boolean}

tools/dictionary.js, line 128

Check if the dictionary contains an entry for a key.

Name	Type	Description
key	String	the lookup key to check

Returns:

if an entry exists, otherwise false

containsValue(value, useStrict){Boolean}

tools/dictionary.js, line 150

Check if the dictionary contains an entry with the value.

NOTE that this function may execute rather slowly, with O(n).

Name	Type	Description
value	any	the value to check
useStrict	Boolean	optional if true entry-values are checked against param value with ===. If false or omitted, values are compared with each other using ==.

Returns:

if an entry exists, otherwise false

get(key){any}

tools/dictionary.js, line 176

Get the value for a key.

Name	Type	Description
key	String	the lookup key with was used to store the entry/value.

Returns:

value for the key, or undefined if the dictionary has no entry for the key.

getKeys(){Array.<String>}

tools/dictionary.js, line 233

Get a list of the keys for all entries in the dictionary.

The returned list has no specific ordering.

NOTE that this may execute rather slowly, with O(n).

NOTE that the returned list is no "view" for the keys, i.e. changes on this list will not be reflected by the dictionary's key-list.

Returns:

list of all keys

privatelookupKey(key){String}

tools/dictionary.js, line 88

Helper function that creates the actual lookup key. The "lookup key" is original key with applied key-prefix.

Name	Type	Description
key	String	the key (without the internal key prefix)

Returns:

key prefixed with the internal key prefix

put(key, value)

tools/dictionary.js, line 106

Put / add an entry to the dictionary.

Name	Type	Description
key	String	the lookup key for the value
value	any	the value to store

remove(key){Boolean}

tools/dictionary.js, line 195

Remove an entry from the dictionary.

NOTE that this may execute rather slowly, with O(n).

Name	Type	Description
key	String	the lookup key for the entry to remove

Returns:

if the entry was removed. If there was no entry for the key and nothing was removed, false is returned.

size(){Number}

tools/dictionary.js, line 250

Get the size of the dictionary.

Returns:

count of entries in the dictionary