An Object that defines a sorted collection of key/value pairs and all their related operations.
A value that will be used to initialize the HashMapObject. It can be an object instance (where each key/value will be directly assigned to the HashMap), or a plain array in which case the keys will be created from each element numeric index
Stores the number of elements inside the HashMapObject
Sort mode that compares values as numbers (Avoid using it with non numeric values)
Sort mode that compares values as strings (alphabetically)
Defines that elements will be sorted upward
Defines that elements will be sorted downward
Checks that specified key value has a valid format (Non empty string)
The key value to test
Get the value that is associated to a key from an existing key/value pair
The key we are looking for
The value that is associated to the provided key
Get the value that is located at a certain position at the ordered list of key/pair values
The position we are looking for
The value that is located at the specified position
Get a list with all the keys from the HashMapObject with the same order as they are stored.
List of strings containing all the HashMapObject sorted keys.
Get a list with all the values from the HashMapObject with the same order as they are stored.
List of elements containing all the HashMapObject sorted values
Tells if the provided value matches a key that's stored inside the HashMapObject
True if the provided value is a valid HashMap key, false in any other case
Get the number of key/value pairs that are currently stored on this HashMapObject instance
integer The number of items inside the collection
Remove and get the last element value from the HashMapObject sorted list
The value on the last element of the list
Delete a key/value pair from the HashMapObject, given it's key.
The key for the key/value pair we want to delete
The value from the key/value pair that's been deleted.
Change the name for an existing key
The name we want to change
The new name that will replace the previous one
True if rename was successful
Reverse the order of the HashMapObject elements
Define a key / value pair and add it to the collection. If the key already exists, value will be replaced.
A string that labels the provided value
A value to be stored with the provided key
The value after being stored to the collection
Remove and get the first element value from the HashMapObject sorted list
The value on the first element of the list
Sort the key/value pairs inside the HashMapObject by their key values.
Defines sort mode: HashMapObject.SORT_STRING or HashMapObject.SORT_NUMERIC
Defines the order for the sorted elements: HashMapObject.SORT_ORDER_ASCENDING (default) or HashMapObject.SORT_ORDER_DESCENDING
True if sort was successful false on failure
Exchange the positions for two key/value pairs on the HashMapObject sorted elements list
The first key to exchange
The second key to exchange
True if the two key/value pairs positions were correctly exchanged
Generated using TypeDoc