Graal Sdk 23.1.1 · org.graalvm.polyglot.proxy.ProxyHashMap

Method Summary

Modifier and Type	Method and Description
public static ProxyHashMap	from(Map<Object, Object> values) Creates a proxy hash map backed by a Java `Map`.
public Object	getHashEntriesIterator() Returns the hash entries iterator.
public long	getHashSize() Returns the number of map entries.
public Object	getHashValue(Value key) Returns the value for the specified key.
public boolean	hasHashEntry(Value key) Returns `true` if the proxy object contains a mapping for the specified key, or else `false`.
public void	putHashEntry(Value key, Value value) Associates the specified value with the specified key.
public default boolean	Returns: `true` when the mapping was removed, `false` when the mapping didn't exist. removeHashEntry(Value key) Removes the mapping for a given key.

Method Detail

from back to summary

from	back to summary
public static ProxyHashMap from(Map<Object, Object> values) Creates a proxy hash map backed by a Java `Map`. The map keys are `as Object unboxed`. If the set values are host values then they will be `unboxed`. Since 21.1

public static ProxyHashMap from(Map<Object, Object> values)

Creates a proxy hash map backed by a Java Map. The map keys are as Object unboxed. If the set values are host values then they will be unboxed.

Since: 21.1

getHashEntriesIterator back to summary

getHashEntriesIterator	back to summary
public Object getHashEntriesIterator() Returns the hash entries iterator. The returned object must be interpreted as an iterator using the semantics of `Context#asValue(Object)` otherwise an `IllegalStateException` is thrown. The iterator elements must be interpreted as two elements array using the semantics of `Context#asValue(Object)`. Examples for valid return values are: `ProxyIterator` `Iterator`, requires `host iterable access` A guest language object representing an iterator Examples for valid iterator elements are: `ProxyArray` `List`, requires `host list access` `Object[2]`, requires `host array access` `Entry`, requires `host map access` A guest language object representing an array Since 21.1 See Also `ProxyIterator`

public Object getHashEntriesIterator()

Returns the hash entries iterator. The returned object must be interpreted as an iterator using the semantics of Context#asValue(Object) otherwise an IllegalStateException is thrown. The iterator elements must be interpreted as two elements array using the semantics of Context#asValue(Object).

Examples for valid return values are:

ProxyIterator
Iterator, requires host iterable access
A guest language object representing an iterator

Examples for valid iterator elements are:

ProxyArray
List, requires host list access
Object[2], requires host array access
Entry, requires host map access
A guest language object representing an array

Since: 21.1
See Also: ProxyIterator

getHashSize	back to summary
public long getHashSize() Returns the number of map entries. Since 21.1

getHashSize

back to summary

public long getHashSize()

Returns the number of map entries.

Since: 21.1

getHashValue	back to summary
public Object getHashValue(Value key) Returns the value for the specified key. Exceptions UnsupportedOperationException: if the operation is unsupported Since 21.1

getHashValue

back to summary

public Object getHashValue(Value key)

Returns the value for the specified key.

Exceptions

UnsupportedOperationException:: if the operation is unsupported

Since

21.1

hasHashEntry back to summary

hasHashEntry	back to summary
public boolean hasHashEntry(Value key) Returns `true` if the proxy object contains a mapping for the specified key, or else `false`. Every key which returns `true` for `hasHashEntry(Value)` must be included in the `iterator` returned by `getHashEntriesIterator()` to allow guest language to enumerate map entries. Since 21.1 See Also `getHashEntriesIterator()`

public boolean hasHashEntry(Value key)

Returns true if the proxy object contains a mapping for the specified key, or else false. Every key which returns true for hasHashEntry(Value) must be included in the iterator returned by getHashEntriesIterator() to allow guest language to enumerate map entries.

Since: 21.1
See Also: getHashEntriesIterator()

putHashEntry back to summary

putHashEntry	back to summary
public void putHashEntry(Value key, Value value) Associates the specified value with the specified key. If the mapping for the specified key does not `exist` then a new mapping is defined otherwise, an existing mapping is updated. Exceptions UnsupportedOperationException: if the operation is unsupported Since 21.1

public void putHashEntry(Value key, Value value)

Associates the specified value with the specified key. If the mapping for the specified key does not exist then a new mapping is defined otherwise, an existing mapping is updated.

Exceptions

UnsupportedOperationException:: if the operation is unsupported

Since

21.1

removeHashEntry back to summary

removeHashEntry	back to summary
public default boolean removeHashEntry(Value key) Removes the mapping for a given key. If the removal of existing mappings is not supported then an `UnsupportedOperationException` is thrown. Returns:boolean `true` when the mapping was removed, `false` when the mapping didn't exist. Exceptions UnsupportedOperationException: if the operation is unsupported Since 21.1

public default boolean removeHashEntry(Value key)

Removes the mapping for a given key. If the removal of existing mappings is not supported then an UnsupportedOperationException is thrown.

Returns:boolean

true when the mapping was removed, false when the mapping didn't exist.

Exceptions

UnsupportedOperationException:: if the operation is unsupported

Since

21.1

public Interface ProxyHashMap

Method Summary

Method Detail