Package org.mozilla.javascript

Class NativeArray

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.IdScriptableObject

org.mozilla.javascript.NativeArray

All Implemented Interfaces:

Serializable, Iterable, Collection, List, SequencedCollection, ConstProperties, DebuggableObject, IdFunctionCall, Scriptable, SymbolScriptable

public class NativeArray
extends IdScriptableObject
implements List

This class implements the Array native object.

Author:

Norris Boyd, Mike McCabe

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

ScriptableObject.KeyComparator

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
NativeArray(long lengthArg)
NativeArray(Object[] array)

Method Summary

Modifier and Type	Method	Description
void	add(int index, Object element)
boolean	add(Object o)
boolean	addAll(int index, Collection c)
boolean	addAll(Collection c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection c)
protected void	defineOwnProperty(Context cx, Object id, ScriptableObject desc, boolean checkValid)	Defines a property on an object.
void	delete(int index)	Removes the indexed property from the object.
void	delete(Symbol key)	Removes an object like the others, but using a Symbol as the key.
Object	execIdCall(IdFunctionObject f, Context cx, Scriptable scope, Scriptable thisObj, Object[] args)	'thisObj' will be null if invoked as constructor, in which case * instance of Scriptable should be returned.
protected void	fillConstructorProperties(IdFunctionObject ctor)
protected int	findInstanceIdInfo(String s)	Map name to id of instance property.
protected int	findPrototypeId(String s)
protected int	findPrototypeId(Symbol k)
Object	get(int index)
Object	get(int index, Scriptable start)	Returns the value of the indexed property or NOT_FOUND.
Object	get(long index)
Object	get(Symbol key, Scriptable start)	Another version of Get that supports Symbol keyed properties.
int	getAttributes(int index)	Get the attributes of an indexed property.
String	getClassName()	Return the name of the class.
Object	getDefaultValue(Class<?> hint)	Implements the [[DefaultValue]] internal method.
Object[]	getIds(boolean nonEnumerable, boolean getSymbols)
List<Integer>	getIndexIds()
protected String	getInstanceIdName(int id)	Map id back to property name it defines.
protected Object	getInstanceIdValue(int id)	Get id value. * If id value is constant, descendant can call cacheIdValue to store * value in the permanent cache. * Default implementation creates IdFunctionObject instance for given id * and cache its value
long	getLength()
protected int	getMaxInstanceId()	Get maximum id findInstanceIdInfo can generate.
protected ScriptableObject	getOwnPropertyDescriptor(Context cx, Object id)
boolean	has(int index, Scriptable start)	Returns true if the property index is defined.
boolean	has(Symbol key, Scriptable start)	A version of "has" that supports symbols.
int	indexOf(Object o)
protected void	initPrototypeId(int id)
boolean	isEmpty()
Iterator	iterator()
long	jsGet_length()	Deprecated. Use getLength() instead.
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(int start)
void	put(int index, Scriptable start, Object value)	Sets the value of the indexed property, creating it if need be.
void	put(String id, Scriptable start, Object value)	Sets the value of the named property, creating it if need be.
void	put(Symbol key, Scriptable start, Object value)	Implementation of put required by SymbolScriptable objects.
Object	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection c)
boolean	retainAll(Collection c)
Object	set(int index, Object element)
protected void	setInstanceIdAttributes(int id, int attr)	Update the attributes of the given instance property.
protected void	setInstanceIdValue(int id, Object value)	Set or delete id value.
void	setPrototype(Scriptable p)	Sets the prototype of the object.
int	size()
List	subList(int fromIndex, int toIndex)
Object[]	toArray()
Object[]	toArray(Object[] a)

Methods inherited from class org.mozilla.javascript.IdScriptableObject

activatePrototypeMap, addIdFunctionProperty, defaultGet, defaultHas, defaultPut, delete, ensureType, ensureType, exportAsJSClass, findInstanceIdInfo, get, getAttributes, getAttributes, has, hasPrototypeMap, initPrototypeConstructor, initPrototypeMethod, initPrototypeMethod, initPrototypeMethod, initPrototypeValue, initPrototypeValue, instanceIdInfo, setAttributes

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Constructor Details

NativeArray

public NativeArray(long lengthArg)

NativeArray

public NativeArray(Object[] array)

Method Details

getClassName

public String getClassName()

Description copied from class: ScriptableObject

Return the name of the class.

This is typically the same name as the constructor. Classes extending ScriptableObject must implement this abstract method.

Specified by:

getClassName in interface Scriptable

Specified by:

getClassName in class ScriptableObject

getMaxInstanceId

protected int getMaxInstanceId()

Description copied from class: IdScriptableObject

Get maximum id findInstanceIdInfo can generate.

Overrides:

getMaxInstanceId in class IdScriptableObject

setInstanceIdAttributes

protected void setInstanceIdAttributes(int id,
 int attr)

Description copied from class: IdScriptableObject

Update the attributes of the given instance property. Classes which want to support changing property attributes via Object.defineProperty must override this method. The default implementation throws InternalError.

Overrides:

setInstanceIdAttributes in class IdScriptableObject

Parameters:

id - the instance property id

attr - the new attribute bitset

findInstanceIdInfo

protected int findInstanceIdInfo(String s)

Description copied from class: IdScriptableObject

Map name to id of instance property. Should return 0 if not found or the result of IdScriptableObject.instanceIdInfo(int, int).

Overrides:

findInstanceIdInfo in class IdScriptableObject

getInstanceIdName

protected String getInstanceIdName(int id)

Description copied from class: IdScriptableObject

Map id back to property name it defines.

Overrides:

getInstanceIdName in class IdScriptableObject

getInstanceIdValue

protected Object getInstanceIdValue(int id)

Description copied from class: IdScriptableObject

Get id value. * If id value is constant, descendant can call cacheIdValue to store * value in the permanent cache. * Default implementation creates IdFunctionObject instance for given id * and cache its value

Overrides:

getInstanceIdValue in class IdScriptableObject

setInstanceIdValue

protected void setInstanceIdValue(int id,
 Object value)

Description copied from class: IdScriptableObject

Set or delete id value. If value == NOT_FOUND , the implementation should make sure that the following getInstanceIdValue return NOT_FOUND.

Overrides:

setInstanceIdValue in class IdScriptableObject

fillConstructorProperties

protected void fillConstructorProperties(IdFunctionObject ctor)

Overrides:

fillConstructorProperties in class IdScriptableObject

initPrototypeId

protected void initPrototypeId(int id)

Overrides:

initPrototypeId in class IdScriptableObject

execIdCall

public Object execIdCall(IdFunctionObject f,
 Context cx,
 Scriptable scope,
 Scriptable thisObj,
 Object[] args)

Description copied from class: IdScriptableObject

'thisObj' will be null if invoked as constructor, in which case * instance of Scriptable should be returned.

Specified by:

execIdCall in interface IdFunctionCall

Overrides:

execIdCall in class IdScriptableObject

setPrototype

public void setPrototype(Scriptable p)

Description copied from class: ScriptableObject

Sets the prototype of the object.

Specified by:

setPrototype in interface Scriptable

Overrides:

setPrototype in class ScriptableObject

Parameters:

p - the prototype to set

get

public Object get(int index,
 Scriptable start)

Description copied from class: ScriptableObject

Returns the value of the indexed property or NOT_FOUND.

Specified by:

get in interface Scriptable

Overrides:

get in class ScriptableObject

Parameters:

index - the numeric index for the property

start - the object in which the lookup began

Returns:

the value of the property (may be null), or NOT_FOUND

See Also:

• Scriptable.get(String,Scriptable)

has

public boolean has(int index,
 Scriptable start)

Description copied from class: ScriptableObject

Returns true if the property index is defined.

Specified by:

has in interface Scriptable

Overrides:

has in class ScriptableObject

Parameters:

index - the numeric index for the property

start - the object in which the lookup began

Returns:

true if and only if the property was found in the object

See Also:

• Scriptable.get(int, Scriptable)
• ScriptableObject.getProperty(Scriptable, int)

has

public boolean has(Symbol key,
 Scriptable start)

Description copied from class: ScriptableObject

A version of "has" that supports symbols.

Specified by:

has in interface SymbolScriptable

Overrides:

has in class IdScriptableObject

get

public Object get(Symbol key,
 Scriptable start)

Description copied from class: ScriptableObject

Another version of Get that supports Symbol keyed properties.

Specified by:

get in interface SymbolScriptable

Overrides:

get in class IdScriptableObject

put

public void put(Symbol key,
 Scriptable start,
 Object value)

Description copied from class: ScriptableObject

Implementation of put required by SymbolScriptable objects.

Specified by:

put in interface SymbolScriptable

Overrides:

put in class IdScriptableObject

delete

public void delete(Symbol key)

Description copied from class: ScriptableObject

Removes an object like the others, but using a Symbol as the key.

Specified by:

delete in interface SymbolScriptable

Overrides:

delete in class IdScriptableObject

put

public void put(String id,
 Scriptable start,
 Object value)

Description copied from class: ScriptableObject

Sets the value of the named property, creating it if need be.

If the property was created using defineProperty, the appropriate setter method is called.

If the property's attributes include READONLY, no action is taken. This method will actually set the property in the start object.

Specified by:

put in interface Scriptable

Overrides:

put in class IdScriptableObject

Parameters:

id - the name of the property

start - the object whose property is being set

value - value to set the property to

See Also:

• Scriptable.has(String, Scriptable)
• Scriptable.get(String, Scriptable)
• ScriptableObject.putProperty(Scriptable, String, Object)
• Context.toObject(Object, Scriptable)

put

public void put(int index,
 Scriptable start,
 Object value)

Description copied from class: ScriptableObject

Sets the value of the indexed property, creating it if need be.

Specified by:

put in interface Scriptable

Overrides:

put in class ScriptableObject

Parameters:

index - the numeric index for the property

start - the object whose property is being set

value - value to set the property to

See Also:

• Scriptable.has(int, Scriptable)
• Scriptable.get(int, Scriptable)
• ScriptableObject.putProperty(Scriptable, int, Object)
• Context.toObject(Object, Scriptable)

delete

public void delete(int index)

Description copied from class: ScriptableObject

Removes the indexed property from the object.

If the property is not found, or it has the PERMANENT attribute, no action is taken.

Specified by:

delete in interface Scriptable

Overrides:

delete in class ScriptableObject

Parameters:

index - the numeric index for the property

See Also:

• Scriptable.get(int, Scriptable)
• ScriptableObject.deleteProperty(Scriptable, int)

getIds

public Object[] getIds(boolean nonEnumerable,
 boolean getSymbols)

getIndexIds

public List<Integer> getIndexIds()

getDefaultValue

public Object getDefaultValue(Class<?> hint)

Description copied from class: ScriptableObject

Implements the [[DefaultValue]] internal method.

Note that the toPrimitive conversion is a no-op for every type other than Object, for which [[DefaultValue]] is called. See ECMA 9.1.

A hint of null means "no hint".

Specified by:

getDefaultValue in interface Scriptable

Overrides:

getDefaultValue in class ScriptableObject

Parameters:

hint - the type hint

Returns:

the default value for the object

See ECMA 8.6.2.6.

getAttributes

public int getAttributes(int index)

Description copied from class: ScriptableObject

Get the attributes of an indexed property.

Overrides:

getAttributes in class ScriptableObject

Parameters:

index - the numeric index for the property

Returns:

the bitset of attributes

See Also:

• ScriptableObject.has(String, Scriptable)
• ScriptableObject.READONLY
• ScriptableObject.DONTENUM
• ScriptableObject.PERMANENT
• ScriptableObject.EMPTY

getOwnPropertyDescriptor

protected ScriptableObject getOwnPropertyDescriptor(Context cx,
 Object id)

Overrides:

getOwnPropertyDescriptor in class IdScriptableObject

defineOwnProperty

protected void defineOwnProperty(Context cx,
 Object id,
 ScriptableObject desc,
 boolean checkValid)

Description copied from class: ScriptableObject

Defines a property on an object.

Based on [[DefineOwnProperty]] from 8.12.10 of the spec.

Overrides:

defineOwnProperty in class IdScriptableObject

Parameters:

cx - the current Context

id - the name/index of the property

desc - the new property descriptor, as described in 8.6.1

checkValid - whether to perform validity checks

getLength

public long getLength()

jsGet_length

@Deprecated
public long jsGet_length()

Deprecated.

Use getLength() instead.

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection

Specified by:

contains in interface List

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

containsAll

public boolean containsAll(Collection c)

Specified by:

containsAll in interface Collection

Specified by:

containsAll in interface List

size

public int size()

Specified by:

size in interface Collection

Specified by:

size in interface List

Overrides:

size in class ScriptableObject

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface List

Overrides:

isEmpty in class ScriptableObject

get

public Object get(long index)

get

public Object get(int index)

Specified by:

get in interface List

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List

iterator

public Iterator iterator()

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface List

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

listIterator

public ListIterator listIterator(int start)

Specified by:

listIterator in interface List

add

public boolean add(Object o)

Specified by:

add in interface Collection

Specified by:

add in interface List

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection

Specified by:

remove in interface List

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface List

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface List

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface List

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface List

add

public void add(int index,
 Object element)

Specified by:

add in interface List

addAll

public boolean addAll(int index,
 Collection c)

Specified by:

addAll in interface List

set

public Object set(int index,
 Object element)

Specified by:

set in interface List

remove

public Object remove(int index)

Specified by:

remove in interface List

subList

public List subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List

findPrototypeId

protected int findPrototypeId(Symbol k)

Overrides:

findPrototypeId in class IdScriptableObject

findPrototypeId

protected int findPrototypeId(String s)

Overrides:

findPrototypeId in class IdScriptableObject