Script: Class dw.util.Map
Class Map
- Object
- dw.util.Map
Represents a Map of objects.
All Known Subclasses
HashMap, LinkedHashMap, SortedMap
Properties
empty : boolean Read Only
Identifies if this map is empty.
static EMPTY_MAP : Map
Convenience variable, for an empty and immutable list.
length : Number Read Only
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'.
Constructor Summary
This class does not have a constructor, so you cannot create it directly. To get an instance of this class, use one of the subclass constructors.
Method Summary
clear() : void
Clears the map of all objects.
containsKey(key : Object) : boolean
Identifies if this map contains an element identfied by the specified key.
containsValue(value : Object) : boolean
Identifies if this map contains an element identfied by the specified value.
Returns a set of the map's entries.
Returns the object associated with the key or null.
REturns the size of the map.
isEmpty() : boolean
Identifies if this map is empty.
Returns a set of the map's keys.
put(key : Object, value : Object) : Object
Puts the specified value into the map using the specified key to identify it.
Copies all of the objects inside the specified map into this map.
Removes the object from the map that is identified by the key.
Returns the size of the map.
values() : Collection
Returns a collection of the values contained in this map.
values() : Collection
Returns a collection of the values contained in this map.
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
clear
clear() : void
Clears the map of all objects.
containsKey
containsKey(key : Object) : boolean
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
containsValue(value : Object) : boolean
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
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
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
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
Identifies if this map is empty.
Returns:
true if the map is empty, false otherwise.
keySet
keySet() : Set
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
put(key : Object, value : Object) : Object
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
putAll(other : Map) : 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
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
Returns the size of the map.
Returns:
the number of objects in the map.
values
values() : Collection
Returns a collection of the values contained in this map.
API Versioned:
No longer available as of version 16.1. Returns an independent modifiable collection holding all values.
Returns:
a collection of the values contained in this map
values
values() : Collection
Returns a collection of the values contained in this map.
API Versioned:
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.
Returns:
a collection of the values contained in this map