Class NativeJavaList
- java.lang.Object
-
- org.mozilla.javascript.NativeJavaObject
-
- org.mozilla.javascript.NativeJavaList
-
- All Implemented Interfaces:
java.io.Serializable
,Scriptable
,SymbolScriptable
,Wrapper
public class NativeJavaList extends NativeJavaObject
NativeJavaList
is a wrapper for java objects implementingjava.util.List
interface. This wrapper delegates index based access in javascript (likevalue[x] = 3
) to the accordingList.get(int)
,List.set(int, Object)
andList.add(Object)
methods. This allows you to use java lists in many places like a javascriptArray
.Supported functions:
- index based access is delegated to List.get/set/add. If
index >= length
, the skipped elements will be filled withnull
values - iterator support with
for...of
(provided by NativeJavaObject for all iterables) - when iterating with
for .. in
(orfor each .. in
) thengetIds
+ index based access is used. - reading and setting
length
property. When modifying the length property, the list is either truncated or will be filled withnull
values up tolength
- deleting entries:
delete value[index]
will be equivalent withvalue[index] = null
and is implemented to provide array compatibility.
Note: Although
JavaList
looks like a javascript-Array
, it is not anArray
. Some methods behave very similar likeArray.indexOf
andjava.util.List.indexOf
, others are named differently likeArray.includes
vs.java.util.List.contains
. EspeciallyforEach
is different inArray
andjava.util.List
. Also deleting entries will set entries tonull
instead toUndefined
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<java.lang.Object>
list
private static long
serialVersionUID
-
Fields inherited from class org.mozilla.javascript.NativeJavaObject
CONVERSION_NONE, CONVERSION_NONTRIVIAL, CONVERSION_TRIVIAL, isAdapter, javaObject, members, parent, prototype, staticType
-
Fields inherited from interface org.mozilla.javascript.Scriptable
NOT_FOUND
-
-
Constructor Summary
Constructors Constructor Description NativeJavaList(Scriptable scope, java.lang.Object list)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
delete(int index)
Removes a property from this object.private void
ensureCapacity(int minCapacity)
java.lang.Object
get(int index, Scriptable start)
Get a property from the object selected by an integral index.java.lang.Object
get(java.lang.String name, Scriptable start)
Get a named property from the object.java.lang.Object
get(Symbol key, Scriptable start)
Return the value of the property with the specified key, or NOT_FOUND.java.lang.String
getClassName()
Get the name of the set of objects implemented by this Java class.java.lang.Object[]
getIds()
Get an array of property ids.boolean
has(int index, Scriptable start)
Indicates whether or not an indexed property is defined in an object.boolean
has(java.lang.String name, Scriptable start)
Indicates whether or not a named property is defined in an object.boolean
has(Symbol key, Scriptable start)
Return true if the specified property exists.private boolean
isWithValidIndex(int index)
void
put(int index, Scriptable start, java.lang.Object value)
Sets an indexed property in this object.void
put(java.lang.String name, Scriptable start, java.lang.Object value)
Sets a named property in this object.private void
setLength(java.lang.Object val)
-
Methods inherited from class org.mozilla.javascript.NativeJavaObject
canConvert, coerceType, coerceTypeImpl, createInterfaceAdapter, delete, delete, getConversionWeight, getDefaultValue, getParentScope, getPrototype, getSizeRank, hasInstance, init, initMembers, put, reportConversionError, setParentScope, setPrototype, unwrap, wrap
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
list
private java.util.List<java.lang.Object> list
-
-
Constructor Detail
-
NativeJavaList
public NativeJavaList(Scriptable scope, java.lang.Object list)
-
-
Method Detail
-
getClassName
public java.lang.String getClassName()
Description copied from interface:Scriptable
Get the name of the set of objects implemented by this Java class. This corresponds to the [[Class]] operation in ECMA and is used by Object.prototype.toString() in ECMA.See ECMA 8.6.2 and 15.2.4.2.
- Specified by:
getClassName
in interfaceScriptable
- Overrides:
getClassName
in classNativeJavaObject
-
has
public boolean has(java.lang.String name, Scriptable start)
Description copied from interface:Scriptable
Indicates whether or not a named property is defined in an object. Does not traverse the prototype chain.The property is specified by a String name as defined for the
get
method.- Specified by:
has
in interfaceScriptable
- Overrides:
has
in classNativeJavaObject
- Parameters:
name
- the name of the propertystart
- the object in which the lookup began- Returns:
- true if and only if the named property is found in the object
- See Also:
Scriptable.get(String, Scriptable)
,ScriptableObject.getProperty(Scriptable, String)
-
has
public boolean has(int index, Scriptable start)
Description copied from interface:Scriptable
Indicates whether or not an indexed property is defined in an object. Does not traverse the prototype chain.The property is specified by an integral index as defined for the
get
method.- Specified by:
has
in interfaceScriptable
- Overrides:
has
in classNativeJavaObject
- Parameters:
index
- the numeric index for the propertystart
- the object in which the lookup began- Returns:
- true if and only if the indexed property is found in the object
- See Also:
Scriptable.get(int, Scriptable)
,ScriptableObject.getProperty(Scriptable, int)
-
delete
public void delete(int index)
Description copied from interface:Scriptable
Removes a property from this object. The property is specified by an integral index as defined forget
.To delete properties defined in a prototype chain, see deleteProperty in ScriptableObject. Identical to
delete(String)
except that an integral index is used to select the property.- Specified by:
delete
in interfaceScriptable
- Overrides:
delete
in classNativeJavaObject
- Parameters:
index
- the numeric index for the property- See Also:
Scriptable.get(int, Scriptable)
,ScriptableObject.deleteProperty(Scriptable, int)
-
has
public boolean has(Symbol key, Scriptable start)
Description copied from interface:SymbolScriptable
Return true if the specified property exists.- Specified by:
has
in interfaceSymbolScriptable
- Overrides:
has
in classNativeJavaObject
-
get
public java.lang.Object get(java.lang.String name, Scriptable start)
Description copied from interface:Scriptable
Get a named property from the object. Looks property up in this object and returns the associated value if found. Returns NOT_FOUND if not found. Note that this method is not expected to traverse the prototype chain. This is different from the ECMA [[Get]] operation. Depending on the property selector, the runtime will call this method or the form ofget
that takes an integer:JavaScript code Java code a.b a.get("b", a) a["foo"] a.get("foo", a) a[3] a.get(3, a) a["3"] a.get(3, a) a[3.0] a.get(3, a) a["3.0"] a.get("3.0", a) a[1.1] a.get("1.1", a) a[-4] a.get(-4, a) The values that may be returned are limited to the following:
- java.lang.Boolean objects
- java.lang.String objects
- java.lang.Number objects
- org.mozilla.javascript.Scriptable objects
- null
- The value returned by Context.getUndefinedValue()
- NOT_FOUND
- Specified by:
get
in interfaceScriptable
- Overrides:
get
in classNativeJavaObject
- Parameters:
name
- the name of the propertystart
- the object in which the lookup began- Returns:
- the value of the property (may be null), or NOT_FOUND
- See Also:
Context.getUndefinedValue()
-
get
public java.lang.Object get(int index, Scriptable start)
Description copied from interface:Scriptable
Get a property from the object selected by an integral index. Identical toget(String, Scriptable)
except that an integral index is used to select the property.- Specified by:
get
in interfaceScriptable
- Overrides:
get
in classNativeJavaObject
- Parameters:
index
- the numeric index for the propertystart
- 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)
-
get
public java.lang.Object get(Symbol key, Scriptable start)
Description copied from interface:SymbolScriptable
Return the value of the property with the specified key, or NOT_FOUND.- Specified by:
get
in interfaceSymbolScriptable
- Overrides:
get
in classNativeJavaObject
-
put
public void put(int index, Scriptable start, java.lang.Object value)
Description copied from interface:Scriptable
Sets an indexed property in this object.The property is specified by an integral index as defined for
get
.Identical to
put(String, Scriptable, Object)
except that an integral index is used to select the property.- Specified by:
put
in interfaceScriptable
- Overrides:
put
in classNativeJavaObject
- Parameters:
index
- the numeric index for the propertystart
- the object whose property is being setvalue
- 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)
-
put
public void put(java.lang.String name, Scriptable start, java.lang.Object value)
Description copied from interface:Scriptable
Sets a named property in this object.The property is specified by a string name as defined for
get
.The possible values that may be passed in are as defined for
get
. A class that implements this method may choose to ignore calls to set certain properties, in which case those properties are effectively read-only.For properties defined in a prototype chain, use
putProperty
in ScriptableObject.Note that if a property a is defined in the prototype p of an object o, then evaluating
o.a = 23
will causeset
to be called on the prototype p with o as the start parameter. To preserve JavaScript semantics, it is the Scriptable object's responsibility to modify o.This design allows properties to be defined in prototypes and implemented in terms of getters and setters of Java values without consuming slots in each instance.
The values that may be set are limited to the following:
- java.lang.Boolean objects
- java.lang.String objects
- java.lang.Number objects
- org.mozilla.javascript.Scriptable objects
- null
- The value returned by Context.getUndefinedValue()
Arbitrary Java objects may be wrapped in a Scriptable by first calling
Context.toObject
. This allows the property of a JavaScript object to contain an arbitrary Java object as a value.Note that
has
will be called by the runtime first beforeset
is called to determine in which object the property is defined. Note that this method is not expected to traverse the prototype chain, which is different from the ECMA [[Put]] operation.- Specified by:
put
in interfaceScriptable
- Overrides:
put
in classNativeJavaObject
- Parameters:
name
- the name of the propertystart
- the object whose property is being setvalue
- 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)
-
ensureCapacity
private void ensureCapacity(int minCapacity)
-
setLength
private void setLength(java.lang.Object val)
-
getIds
public java.lang.Object[] getIds()
Description copied from interface:Scriptable
Get an array of property ids. Not all property ids need be returned. Those properties whose ids are not returned are considered non-enumerable.- Specified by:
getIds
in interfaceScriptable
- Overrides:
getIds
in classNativeJavaObject
- Returns:
- an array of Objects. Each entry in the array is either a java.lang.String or a java.lang.Number
-
isWithValidIndex
private boolean isWithValidIndex(int index)
-
-