com.gargoylesoftware.htmlunit.javascript.host

Class Map

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Map

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class Map
extends SimpleScriptable

A JavaScript object for Map.

Author:

Ahmed Ashour

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
Map() Creates an instance.
Map(Object iterable) Creates an instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all elements.
boolean	delete(Object key) Removed the specified element.
Object	entries() Returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order.
Object	get(Object key) Returns the value of the given key.
Object	get(String name, net.sourceforge.htmlunit.corejs.javascript.Scriptable start) Gets a named property from the object.
int	getSize() Returns the size.
boolean	has(Object key) Returns whether an element with the specified key exists or not.
Object	keys() Returns a new Iterator object that contains the keys for each element in the Map object in insertion order.
Map	set(Object key, Object value) Adds the specified pair.
Object	values() Returns a new Iterator object that contains the values for each element in the Map object in insertion order.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

Map

public Map()

Creates an instance.

Map

public Map(Object iterable)

Creates an instance.

Parameters:

iterable - an Array or other iterable object

Method Detail

getSize

public int getSize()

Returns the size.

Returns:

the size

get

public Object get(Object key)

Returns the value of the given key.

Overrides:

get in class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

Parameters:

key - the key

Returns:

the value

set

public Map set(Object key,
      Object value)

Adds the specified pair.

Parameters:

key - the key

value - the value

Returns:

the Map object.

clear

public void clear()

Removes all elements.

delete

public boolean delete(Object key)

Removed the specified element.

Parameters:

key - the key

Returns:

whether the element has been successfully removed

has

public boolean has(Object key)

Returns whether an element with the specified key exists or not.

Parameters:

key - the key

Returns:

whether the element exists or not

get

public Object get(String name,
         net.sourceforge.htmlunit.corejs.javascript.Scriptable start)

Gets a named property from the object. Normally HtmlUnit objects don't need to overwrite this method as properties are defined on the prototypes from the XML configuration. In some cases where "content" of object has priority compared to the properties consider using utility SimpleScriptable.getWithPreemption(String). For fallback case just implement ScriptableWithFallbackGetter.

Specified by:

get in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

Overrides:

get in class SimpleScriptable

entries

public Object entries()

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

keys

public Object keys()

Returns a new Iterator object that contains the keys for each element in the Map object in insertion order.

Returns:

a new Iterator object

values

public Object values()

Returns a new Iterator object that contains the values for each element in the Map object in insertion order.

Returns:

a new Iterator object