- TIBCO BusinessEvents®
- Standard
- Collections
- Map

# Collections.Map

## Description

Map functions

## Categories

Name | Description
--- | ---
`Concurrent` | Concurrent Map functions
`Entry` | Utility Functions for java.util.Map.Entry

## Functions

Name | Signature and Synopsis
--- | ---
`clear` | `void clear ( Object map )` Removes all of the mappings from this map.
`containsKey` | `boolean containsKey ( Object map, Object key )` Returns true, if this map contains a mapping for the specified.
`containsValue` | `boolean containsValue ( Object map, Object value )` Returns true, if this map maps one or more keys to the specified value.
`createHashMap` | `Object createHashMap ( )` Create and return instance of HashMap. The hashmap returned by this function is not thread safe hence any updates if using a multi-threaded RETE should be done carefully.
`createHashMapWithId` | `Object createHashMapWithId ( String mapId )` Create and return instance of HashMap.
`createLinkedHashMap` | `Object createLinkedHashMap ( )` Create and return instance of LinkedHashMap.
`createLinkedHashMapWithId` | `Object createLinkedHashMapWithId ( String mapId )` Create and return instance of LinkedHashMap.
`createMap` | `Object createMap ( String className )` Creates user specified Map implementation
`createMapWithId` | `Object createMapWithId ( String mapId )` Creates user specified Map implementation.
`createTreeMap` | `Object createTreeMap ( )` Create and return instance of TreeMap.
`createTreeMapWithId` | `Object createTreeMapWithId ( String mapId )` Create and return instance of TreeMap.
`deleteMap` | `Object deleteMap ( String mapId )` Deletes the instance of map for the given mapId. This function can not be used if the collection is created with createMap().
`entrySet` | `Object entrySet ( Object map )` Returns a view of the mappings contained in this map.
`get` | `Object get ( Object map, Object key )` Returns the value to which the specified key is mapped.
`getMap` | `Object getMap ( String mapId )` Returns the instance of map for the given mapId.
`isEmpty` | `boolean isEmpty ( Object map )` Returns true, if this map contains no key-value mappings.
`keySet` | `Object keySet ( Object map )` Returns a view of the keys contained in this map.
`put` | `Object put ( Object map, Object key, Object value )` Associates the specified value with the specified key in this map.
`putAll` | `void putAll ( Object map, Object mapToBeAdded )` Copies all of the mappings from the specified map to this map.
`remove` | `Object remove ( Object map, Object key )` Removes the mapping for a key from this map if it is present.
`size` | `int size ( Object map )` Returns the number of key-value mappings in this map.
`values` | `Object values ( Object map )` Returns a view of the values contained in this map.