akasha.core

Class JsMap<K,V>

java.lang.Object

akasha.core.JsMap<K,V>

All Implemented Interfaces:

JsIterable<JsMap.Entry<K,V>>

@JsType(isNative=true,
        name="Map",
        namespace="<global>")
public class JsMap<K,V>
extends java.lang.Object
implements JsIterable<JsMap.Entry<K,V>>

The Map object holds key-value pairs and remembers the original insertion order of the keys.

See Also:

Map - MDN, Map Objects - ECMA

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsMap.Entry<K,V>
static interface	JsMap.ForEachCallback<V>
static interface	JsMap.ForEachCallback2<K,V>
static interface	JsMap.ForEachCallback3<K,V>

Constructor Summary

Constructors

Constructor and Description
JsMap() The Map() constructor creates Map objects.
JsMap(JsIterable<JsMap.Entry<K,V>> pairs) The Map() constructor creates Map objects.
JsMap(JsMap.Entry<K,V>... pairs) The Map() constructor creates Map objects.

Method Summary

Modifier and Type	Method and Description
void	clear() The clear() method removes all elements from a Map object.
boolean	delete(K key) The delete() method removes the specified element from a Map object.
JsIteratorIterable<JsMap.Entry<K,V>>	entries() The entries() method returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order.
void	forEach(JsMap.ForEachCallback<V> forEachCallback) The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.
void	forEach(JsMap.ForEachCallback2<K,V> forEachCallback) The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.
void	forEach(JsMap.ForEachCallback3<K,V> forEachCallback) The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.
V	get(K key) The get() method returns a specified element from a Map object.
boolean	has(K key) The has() method returns a boolean indicating whether an element with the specified value exists in a Map object or not.
JsIteratorIterable<K>	keys() The keys() method returns a new Iterator object that contains the keys for each element in the Map object in insertion order.
JsMap<K,V>	set(K key, V value) The set() method adds a new element with a specified key and value to a Map object.
int	size() The size accessor property returns the number of elements in a Map object.
JsIteratorIterable<V>	values() The values() method returns a new Iterator object that contains the values for each element in the Map object in insertion order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akasha.lang.JsIterable

iterator

Constructor Detail

JsMap

public JsMap()

The Map() constructor creates Map objects.

See Also:

Map() - MDN, Map Constructor - ECMA

JsMap

@SafeVarargs
public JsMap(@Nonnull
                          JsMap.Entry<K,V>... pairs)

The Map() constructor creates Map objects.

Parameters:

pairs - an array of pairs that will be added to the Map.

See Also:

Map() - MDN, Map Constructor - ECMA

JsMap

public JsMap(@Nonnull
             JsIterable<JsMap.Entry<K,V>> pairs)

The Map() constructor creates Map objects.

Parameters:

pairs - an iterable containing pairs that will be added to the Map.

See Also:

Map() - MDN, Map Constructor - ECMA

Method Detail

size

@JsProperty(name="size")
public int size()

The size accessor property returns the number of elements in a Map object.

Returns:

an integer representing how many entries the Set object has.

See Also:

Map.prototype.size - MDN, Map.prototype.size - ECMA

clear

public void clear()

The clear() method removes all elements from a Map object.

See Also:

Map.prototype.clear - MDN, Map.prototype.clear - ECMA

delete

public boolean delete(@Nullable
                      K key)

The delete() method removes the specified element from a Map object.

Parameters:

key - the key of the element to remove from the Map object.

Returns:

true if an element in the Map object has been removed successfully, false if the key is not found in the Map or if the key is not an object.

See Also:

Map.prototype.delete() - MDN, Map.prototype.delete() - ECMA

entries

public JsIteratorIterable<JsMap.Entry<K,V>> entries()

The entries() method returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order.

Returns:

a new iterator object.

See Also:

Map.prototype.entries - MDN, Map.prototype.entries - ECMA

forEach

public void forEach(@Nonnull
                    JsMap.ForEachCallback<V> forEachCallback)

The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.

Parameters:

forEachCallback - the function to execute for each element.

See Also:

Map.prototype.forEach - MDN, Map.prototype.forEach - ECMA

forEach

public void forEach(@Nonnull
                    JsMap.ForEachCallback2<K,V> forEachCallback)

The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.

Parameters:

forEachCallback - the function to execute for each element.

See Also:

Map.prototype.forEach - MDN, Map.prototype.forEach - ECMA

forEach

public void forEach(@Nonnull
                    JsMap.ForEachCallback3<K,V> forEachCallback)

The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order.

Parameters:

forEachCallback - the function to execute for each element.

See Also:

Map.prototype.forEach - MDN, Map.prototype.forEach - ECMA

get

public V get(K key)

The get() method returns a specified element from a Map object.

Parameters:

key - the key of the element to return from the Map object.

Returns:

the value associated with the specified key, or null if the key is present in the Map object.

See Also:

Map.prototype.get - MDN, Map.prototype.get - ECMA

has

public boolean has(@Nullable
                   K key)

The has() method returns a boolean indicating whether an element with the specified value exists in a Map object or not.

Returns:

the value to test for presence in the Map object.

See Also:

Map.prototype.has - MDN, Map.prototype.has - ECMA

keys

@Nonnull
public JsIteratorIterable<K> keys()

The keys() method returns a new Iterator object that contains the keys for each element in the Map object in insertion order.

Returns:

a new iterator object containing the keys for each element in the Map, in insertion order.

See Also:

Map.prototype.keys - MDN, Map.prototype.keys - ECMA

set

@Nonnull
public JsMap<K,V> set(@Nullable
                               K key,
                               @Nullable
                               V value)

The set() method adds a new element with a specified key and value to a Map object.

Parameters:

key - the key of the element to add to the Map object.

value - the value of the element to add to the Map object.

Returns:

this Map

See Also:

Map.prototype.set() - MDN, Map.prototype.set() - ECMA

values

@Nonnull
public JsIteratorIterable<V> values()

The values() method returns a new Iterator object that contains the values for each element in the Map object in insertion order.

Returns:

a new iterator object containing the values for each element in the Map, in insertion order.

See Also:

Map.prototype.values - MDN, Map.prototype.values - ECMA