akasha.core

Class JsWeakMap<K,V>

java.lang.Object

akasha.core.JsWeakMap<K,V>

@JsType(name="WeakMap",
        isNative=true,
        namespace="<global>")
public class JsWeakMap<K,V>
extends java.lang.Object

The WeakMap object is a collection of key/value pairs in which the keys are weakly referenced. The keys must be objects and the values can be arbitrary values.

See Also:

WeakMap - MDN, WeakMap Objects - ECMA

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsWeakMap.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JsWeakMap() The WeakMap() constructor creates WeakMap objects which are a collections of key/value pairs in which the keys are weakly referenced.
JsWeakMap(JsIterable<JsWeakMap.Entry<K,V>> pairs) The WeakMap() constructor creates WeakMap objects which are a collections of key/value pairs in which the keys are weakly referenced.
JsWeakMap(JsWeakMap.Entry<K,V>... pairs) The WeakMap() constructor creates WeakMap objects which are a collections of key/value pairs in which the keys are weakly referenced.

Method Summary

Modifier and Type	Method and Description
boolean	delete(K key) The delete() method removes the specified element from a WeakMap object.
V	get(K key) The get() method returns a specified element from a WeakMap object.
boolean	has(K key) The has() method returns a boolean indicating whether an element with the specified key exists in the WeakMap object or not.
JsWeakMap<K,V>	set(K key, V value) The set() method adds a new element with a specified key and value to a WeakMap object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsWeakMap

public JsWeakMap()

The WeakMap() constructor creates WeakMap objects which are a collections of key/value pairs in which the keys are weakly referenced. The keys must be objects and the values can be arbitrary values.

See Also:

WeakMap() - MDN, WeakMap Constructor - ECMA

JsWeakMap

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

The WeakMap() constructor creates WeakMap objects which are a collections of key/value pairs in which the keys are weakly referenced. The keys must be objects and the values can be arbitrary values.

Parameters:

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

See Also:

WeakMap() - MDN, WeakMap Constructor - ECMA

JsWeakMap

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

The WeakMap() constructor creates WeakMap objects which are a collections of key/value pairs in which the keys are weakly referenced. The keys must be objects and the values can be arbitrary values.

Parameters:

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

See Also:

WeakMap() - MDN, WeakMap Constructor - ECMA

Method Detail

delete

public boolean delete(@Nonnull
                      K key)

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

Parameters:

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

Returns:

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

See Also:

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

get

@Nullable
public V get(@Nonnull
                       K key)

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

Parameters:

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

Returns:

the element associated with the specified key in the WeakMap object or null if no such element.

See Also:

WeakMap.prototype.get() - MDN, WeakMap.prototype.get() - ECMA

has

public boolean has(@Nonnull
                   K key)

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

Parameters:

key - the key of the element to test for presence in the WeakMap object.

Returns:

true if an element with the specified key exists in the WeakMap object, otherwise false.

See Also:

WeakMap.prototype.has() - MDN, WeakMap.prototype.has() - ECMA

set

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

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

Parameters:

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

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

Returns:

this WeakMap

See Also:

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