# Class Map - [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - [dw.util.Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md) Represents a Map of objects. ## All Known Subclasses [HashMap](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.HashMap.md), [LinkedHashMap](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.LinkedHashMap.md), [SortedMap](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.SortedMap.md) ## Property Summary | Property | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | [EMPTY_MAP](#empty_map): [Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md) | Convenience variable, for an empty and immutable list. | | [empty](#empty): [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md) `(read-only)` | Identifies if this map is empty. | | [length](#length): [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md) `(read-only)` | REturns the size of the map. | ## Constructor Summary This class does not have a constructor, so you cannot create it directly. ## Method Summary | Method | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | [clear](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#clear)() | Clears the map of all objects. | | [containsKey](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#containskeyobject)([Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)) | Identifies if this map contains an element identfied by the specified key. | | [containsValue](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#containsvalueobject)([Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)) | Identifies if this map contains an element identfied by the specified value. | | [entrySet](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#entryset)() | Returns a set of the map's entries. | | [get](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#getobject)([Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)) | Returns the object associated with the key or null. | | [getLength](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#getlength)() | REturns the size of the map. | | [isEmpty](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#isempty)() | Identifies if this map is empty. | | [keySet](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#keyset)() | Returns a set of the map's keys. | | [put](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#putobject-object)([Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md), [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)) | Puts the specified value into the map using the specified key to identify it. | | [putAll](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#putallmap)([Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md)) | Copies all of the objects inside the specified map into this map. | | [remove](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#removeobject)([Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)) | Removes the object from the map that is identified by the key. | | [size](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#size)() | Returns the size of the map. | | [values](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#values---variant-1)() | Returns a collection of the values contained in this map. | | [values](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md#values---variant-2)() | Returns a collection of the values contained in this map. | ### Methods inherited from class Object [assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject) ## Property Details ### EMPTY_MAP - EMPTY_MAP: [Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md) - : Convenience variable, for an empty and immutable list. *** ### empty - empty: [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md) `(read-only)` - : Identifies if this map is empty. *** ### length - length: [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md) `(read-only)` - : REturns the size of the map. This is a bean attribute method and supports the access to the collections length similar to a ECMA array, such as 'products.length'. *** ## Method Details ### clear() - clear(): void - : Clears the map of all objects. *** ### containsKey(Object) - containsKey(key: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)): [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md) - : Identifies if this map contains an element identfied by the specified key. **Parameters:** - key - the key to use. **Returns:** - true if this map contains an element whose key is equal to the specified key. *** ### containsValue(Object) - containsValue(value: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)): [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md) - : Identifies if this map contains an element identfied by the specified value. **Parameters:** - value - the value to use. **Returns:** - true if this map contains an element whose value is equal to the specified value. *** ### entrySet() - entrySet(): [Set](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Set.md) - : Returns a set of the map's entries. The returned set is actually a view to the entries of this map. **Returns:** - a set of the map's entries. *** ### get(Object) - get(key: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Returns the object associated with the key or null. **Parameters:** - key - the key to use. **Returns:** - the object associated with the key or null. *** ### getLength() - getLength(): [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md) - : REturns the size of the map. This is a bean attribute method and supports the access to the collections length similar to a ECMA array, such as 'products.length'. **Returns:** - the number of objects in the map. *** ### isEmpty() - isEmpty(): [Boolean](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Boolean.md) - : Identifies if this map is empty. **Returns:** - true if the map is empty, false otherwise. *** ### keySet() - keySet(): [Set](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Set.md) - : Returns a set of the map's keys. The returned set is actually a view to the keys of this map. **Returns:** - a set of the map's keys. *** ### put(Object, Object) - put(key: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md), value: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Puts the specified value into the map using the specified key to identify it. **Parameters:** - key - the key to use to identify the value. - value - the object to put into the map. **Returns:** - previous value associated with specified key, or null if there was no mapping for key. *** ### putAll(Map) - putAll(other: [Map](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Map.md)): void - : Copies all of the objects inside the specified map into this map. **Parameters:** - other - the map whose contents are copied into this map. *** ### remove(Object) - remove(key: [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md) - : Removes the object from the map that is identified by the key. **Parameters:** - key - the key that identifies the object to remove. **Returns:** - the removed object or null. *** ### size() - size(): [Number](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Number.md) - : Returns the size of the map. **Returns:** - the number of objects in the map. *** ### values() - Variant 1 - values(): [Collection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) - : Returns a collection of the values contained in this map. **Returns:** - a collection of the values contained in this map **API Version:** :::note No longer available as of version 16.1. Returns an independent modifiable collection holding all values. ::: *** ### values() - Variant 2 - values(): [Collection](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.util.Collection.md) - : Returns a collection of the values contained in this map. **Returns:** - a collection of the values contained in this map **API Version:** :::note Available from version 16.1. Returns a view on the values of this map like keySet() and entrySet() do. Former version returned a shallow copy of this. ::: ***