public class NativeJavaList extends NativeJavaObject
NativeJavaList
is a wrapper for java objects implementing java.util.List
interface. This wrapper delegates index based access in javascript (like
value[x] = 3
) to the according List.get(int)
, List.set(int, Object)
and
List.add(Object)
methods. This allows you to use java lists in many places like a
javascript Array
.
Supported functions:
index >= length
,
the skipped elements will be filled with null
values
for...of
(provided by NativeJavaObject for all
iterables)
for .. in
(or for each .. in
) then
getIds
+ index based access is used.
length
property. When modifying the length property, the
list is either truncated or will be filled with null
values up to length
delete value[index]
will be equivalent with
value[index] = null
and is implemented to provide array compatibility.
Note: Although JavaList
looks like a javascript-Array
, it is
not an
Array
. Some methods behave very similar like Array.indexOf
and
java.util.List.indexOf
, others are named differently like Array.includes
vs.
java.util.List.contains
. Especially forEach
is different in Array
and java.util.List
. Also deleting entries will set entries to null
instead to Undefined
isAdapter, javaObject, members, parent, prototype, staticType
NOT_FOUND
Constructor and Description |
---|
NativeJavaList(Scriptable scope,
java.lang.Object list) |
Modifier and Type | Method and Description |
---|---|
void |
delete(int index)
Removes a property from this object.
|
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.
|
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.
|
canConvert, coerceType, createInterfaceAdapter, delete, delete, getDefaultValue, getParentScope, getPrototype, hasInstance, initMembers, put, setParentScope, setPrototype, unwrap, wrap
public NativeJavaList(Scriptable scope, java.lang.Object list)
public java.lang.String getClassName()
Scriptable
See ECMA 8.6.2 and 15.2.4.2.
getClassName
in interface Scriptable
getClassName
in class NativeJavaObject
public boolean has(java.lang.String name, Scriptable start)
Scriptable
The property is specified by a String name
as defined for the get
method.
has
in interface Scriptable
has
in class NativeJavaObject
name
- the name of the propertystart
- the object in which the lookup beganScriptable.get(String, Scriptable)
,
ScriptableObject.getProperty(Scriptable, String)
public boolean has(int index, Scriptable start)
Scriptable
The property is specified by an integral index
as defined for the get
method.
has
in interface Scriptable
has
in class NativeJavaObject
index
- the numeric index for the propertystart
- the object in which the lookup beganScriptable.get(int, Scriptable)
,
ScriptableObject.getProperty(Scriptable, int)
public void delete(int index)
Scriptable
get
.
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.
delete
in interface Scriptable
delete
in class NativeJavaObject
index
- the numeric index for the propertyScriptable.get(int, Scriptable)
,
ScriptableObject.deleteProperty(Scriptable, int)
public boolean has(Symbol key, Scriptable start)
SymbolScriptable
has
in interface SymbolScriptable
has
in class NativeJavaObject
public java.lang.Object get(java.lang.String name, Scriptable start)
Scriptable
get
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:
get
in interface Scriptable
get
in class NativeJavaObject
name
- the name of the propertystart
- the object in which the lookup beganContext.getUndefinedValue()
public java.lang.Object get(int index, Scriptable start)
Scriptable
get(String, Scriptable)
except that
an integral index is used to select the property.get
in interface Scriptable
get
in class NativeJavaObject
index
- the numeric index for the propertystart
- the object in which the lookup beganScriptable.get(String,Scriptable)
public java.lang.Object get(Symbol key, Scriptable start)
SymbolScriptable
get
in interface SymbolScriptable
get
in class NativeJavaObject
public void put(int index, Scriptable start, java.lang.Object value)
Scriptable
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.
put
in interface Scriptable
put
in class NativeJavaObject
index
- the numeric index for the propertystart
- the object whose property is being setvalue
- value to set the property toScriptable.has(int, Scriptable)
,
Scriptable.get(int, Scriptable)
,
ScriptableObject.putProperty(Scriptable, int, Object)
,
Context.toObject(Object, Scriptable)
public void put(java.lang.String name, Scriptable start, java.lang.Object value)
Scriptable
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 cause
set
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:
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 before
set
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.
put
in interface Scriptable
put
in class NativeJavaObject
name
- the name of the propertystart
- the object whose property is being setvalue
- value to set the property toScriptable.has(String, Scriptable)
,
Scriptable.get(String, Scriptable)
,
ScriptableObject.putProperty(Scriptable, String, Object)
,
Context.toObject(Object, Scriptable)
public java.lang.Object[] getIds()
Scriptable
getIds
in interface Scriptable
getIds
in class NativeJavaObject