public interface JsObject
extends java.rmi.Remote
Host system implementors may find it easier to extend the ScriptableObject class rather than implementing Scriptable when writing host objects.
There are many static methods defined in ScriptableObject that perform the multiple calls to the Scriptable interface needed in order to manipulate properties in prototype chains.
| Modifier and Type | Field and Description |
|---|---|
static int |
DONTDELETE
Property attribute indicating property cannot be deleted.
|
static int |
DONTENUM
Property attribute indicating property is not enumerated.
|
static int |
EMPTY
The empty property attribute.
|
static int |
INTERNAL
Property attribute indicating property cannot be deleted.
|
static int |
READONLY
Property attribute indicating assignment to this property is ignored.
|
| Modifier and Type | Method and Description |
|---|---|
void |
define(java.lang.String propertyName,
java.lang.Object value,
int attributes)
The value can be any of the following type:
java.lang.Boolean
java.lang.Number
java.lang.String
org.apache.bsf.debug.jsdi.JsObject
|
void |
delete(int index)
Removes a property from this object.
|
void |
delete(java.lang.String name)
Removes a property from this object.
|
java.lang.Object |
get(int index) |
java.lang.Object |
get(java.lang.String name)
Get a named property from the object.
|
java.lang.String |
getClassName()
Get the name of the set of objects implemented by this Java class.
|
java.lang.Object |
getDefaultValue(java.lang.Class hint)
Get the default value of the object with a given hint.
|
java.lang.Object[] |
getIds(boolean all)
Returns an array of property ids defined on this object.
|
JsObject |
getPrototype()
Get the prototype of the object.
|
JsObject |
getScope()
The scope is for supporting two things.
|
boolean |
has(int index)
Indicates whether or not an indexed property is defined in an object.
|
boolean |
has(java.lang.String name)
Indicates whether or not a named property is defined in an object.
|
boolean |
hasInstance(JsObject instance)
The instanceof operator.
|
boolean |
isFunction() |
boolean |
isScript() |
void |
put(int index,
java.lang.Object value)
Sets an indexed property in this object.
|
void |
put(java.lang.String name,
java.lang.Object value)
Sets a named property in this object.
|
void |
setPrototype(JsObject prototype)
Set the prototype of the object.
|
void |
setScope(JsObject scope)
Set the prototype of the object.
|
static final int DONTDELETE
ScriptableObject.delete(java.lang.String),
ScriptableObject.getAttributes(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int),
Constant Field Valuesstatic final int DONTENUM
ScriptableObject.getIds(),
ScriptableObject.getAttributes(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int),
Constant Field Valuesstatic final int EMPTY
ScriptableObject.getAttributes(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int),
Constant Field Valuesstatic final int INTERNAL
ScriptableObject.delete(java.lang.String),
ScriptableObject.getAttributes(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int),
Constant Field Valuesstatic final int READONLY
ScriptableObject.put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object),
ScriptableObject.getAttributes(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.setAttributes(java.lang.String, org.mozilla.javascript.Scriptable, int),
Constant Field Valuesvoid define(java.lang.String propertyName,
java.lang.Object value,
int attributes)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionvoid delete(int index)
throws java.rmi.RemoteException
A property can be made permanent by ignoring calls to remove
it.
The property is specified by an integral index
as defined for get.
To delete properties defined in a prototype chain,
first find the owner object of the property and then
call deleteProperty on that owner object.
Identical to delete(String) except that
an integral index is used to select the property.
index - the numeric index for the propertyjava.rmi.RemoteExceptionScriptable.get(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.deleteProperty(org.mozilla.javascript.Scriptable, java.lang.String)void delete(java.lang.String name)
throws java.rmi.RemoteException
A property can be made permanent by ignoring calls to remove it.
The property is specified by a String name
as defined for get.
To delete properties defined in a prototype chain, first find the owner object of the property and then call deleteProperty on that owner object.
name - the identifier for the propertyjava.rmi.RemoteExceptionScriptable.get(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.deleteProperty(org.mozilla.javascript.Scriptable, java.lang.String)java.lang.Object get(java.lang.String name)
throws java.rmi.RemoteException
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:
name - the name of the propertyjava.rmi.RemoteExceptionjava.lang.Object get(int index)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionjava.lang.String getClassName()
throws java.rmi.RemoteException
See ECMA 8.6.2 and 15.2.4.2.
java.rmi.RemoteExceptionjava.lang.Object getDefaultValue(java.lang.Class hint)
throws java.rmi.RemoteException
A hint of null means "no hint".
See ECMA 8.6.2.6.
hint - the type hintjava.rmi.RemoteExceptionjava.lang.Object[] getIds(boolean all)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionJsObject getPrototype() throws java.rmi.RemoteException
java.rmi.RemoteExceptionJsObject getScope() throws java.rmi.RemoteException
java.rmi.RemoteExceptionboolean has(int index)
throws java.rmi.RemoteException
The property is specified by an integral index
as defined for the get method.
index - the numeric index for the propertyjava.rmi.RemoteExceptionScriptable.get(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.getProperty(org.mozilla.javascript.Scriptable, java.lang.String)boolean has(java.lang.String name)
throws java.rmi.RemoteException
The property is specified by a String name
as defined for the get method.
name - the name of the propertyjava.rmi.RemoteExceptionScriptable.get(java.lang.String, org.mozilla.javascript.Scriptable),
ScriptableObject.getProperty(org.mozilla.javascript.Scriptable, java.lang.String)boolean hasInstance(JsObject instance) throws java.rmi.RemoteException
The JavaScript code "lhs instanceof rhs" causes rhs.hasInstance(lhs) to be called.
The return value is implementation dependent so that embedded host objects can return an appropriate value. See the JS 1.3 language documentation for more detail.
This operator corresponds to the proposed EMCA [[HasInstance]] operator.
instance - The value that appeared on the LHS of the instanceof
operatorjava.rmi.RemoteExceptionboolean isFunction()
throws java.rmi.RemoteException
java.rmi.RemoteExceptionboolean isScript()
throws java.rmi.RemoteException
java.rmi.RemoteExceptionvoid put(int index,
java.lang.Object value)
throws java.rmi.RemoteException
The property is specified by an integral index
as defined for get.
index - the numeric index for the propertyvalue - value to set the property tojava.rmi.RemoteExceptionvoid put(java.lang.String name,
java.lang.Object value)
throws java.rmi.RemoteException
The property is specified by a string name
as defined for get.
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:
IMPORTANT: JAVA OBJECTS. The wrapping is not yet supported.
java.rmi.RemoteExceptionvoid setPrototype(JsObject prototype) throws java.rmi.RemoteException
prototype - the prototype to setjava.rmi.RemoteExceptionvoid setScope(JsObject scope) throws java.rmi.RemoteException
prototype - the prototype to setjava.rmi.RemoteException