associateValue
public final Object associateValue(Object key,
Object value)
Associate arbitrary application-specific value with this object.
Value can only be associated with the given object and key only once.
The method ignores any subsequent attempts to change the already
associated value.
The associated values are not serilized.
key
- key object to select particular value.value
- the value to associate
- the passed value if the method is called first time for the
given key or old value for any subsequent calls.
getAssociatedValue(Object key)
callMethod
public static Object callMethod(Context cx,
Scriptable obj,
String methodName,
Object[] args)
Call a method of an object.
cx
- the Context object associated with the current thread.obj
- the JavaScript objectmethodName
- the name of the function propertyargs
- the arguments for the call
callMethod
public static Object callMethod(Scriptable obj,
String methodName,
Object[] args)
Call a method of an object.
obj
- the JavaScript objectmethodName
- the name of the function propertyargs
- the arguments for the call
defineClass
public static void defineClass(Scriptable scope,
Class clazz)
throws IllegalAccessException,
InstantiationException,
InvocationTargetException
Defines JavaScript objects from a Java class that implements Scriptable.
If the given class has a method
static void init(Context cx, Scriptable scope, boolean sealed);
or its compatibility form
static void init(Scriptable scope);
then it is invoked and no further initialization is done.
However, if no such a method is found, then the class's constructors and
methods are used to initialize a class in the following manner.
First, the zero-parameter constructor of the class is called to
create the prototype. If no such constructor exists,
a
EvaluatorException
is thrown.
Next, all methods are scanned for special prefixes that indicate that they
have special meaning for defining JavaScript objects.
These special prefixes are
jsFunction_
for a JavaScript function
jsStaticFunction_
for a JavaScript function that
is a property of the constructor
jsGet_
for a getter of a JavaScript property
jsSet_
for a setter of a JavaScript property
jsConstructor
for a JavaScript function that
is the constructor
If the method's name begins with "jsFunction_", a JavaScript function
is created with a name formed from the rest of the Java method name
following "jsFunction_". So a Java method named "jsFunction_foo" will
define a JavaScript method "foo". Calling this JavaScript function
will cause the Java method to be called. The parameters of the method
must be of number and types as defined by the FunctionObject class.
The JavaScript function is then added as a property
of the prototype.
If the method's name begins with "jsStaticFunction_", it is handled
similarly except that the resulting JavaScript function is added as a
property of the constructor object. The Java method must be static.
If the method's name begins with "jsGet_" or "jsSet_", the method is
considered to define a property. Accesses to the defined property
will result in calls to these getter and setter methods. If no
setter is defined, the property is defined as READONLY.
If the method's name is "jsConstructor", the method is
considered to define the body of the constructor. Only one
method of this name may be defined.
If no method is found that can serve as constructor, a Java
constructor will be selected to serve as the JavaScript
constructor in the following manner. If the class has only one
Java constructor, that constructor is used to define
the JavaScript constructor. If the the class has two constructors,
one must be the zero-argument constructor (otherwise an
EvaluatorException
would have already been thrown
when the prototype was to be created). In this case
the Java constructor with one or more parameters will be used
to define the JavaScript constructor. If the class has three
or more constructors, an
EvaluatorException
will be thrown.
Finally, if there is a method
static void finishInit(Scriptable scope, FunctionObject constructor,
Scriptable prototype)
it will be called to finish any initialization. The
scope
argument will be passed, along with the newly created constructor and
the newly created prototype.
scope
- The scope in which to define the constructor.clazz
- The Java class to use to define the JavaScript objects
and properties.
defineClass
public static void defineClass(Scriptable scope,
Class clazz,
boolean sealed)
throws IllegalAccessException,
InstantiationException,
InvocationTargetException
Defines JavaScript objects from a Java class, optionally
allowing sealing.
Similar to defineClass(Scriptable scope, Class clazz)
except that sealing is allowed. An object that is sealed cannot have
properties added or removed. Note that sealing is not allowed in
the current ECMA/ISO language specification, but is likely for
the next version.
scope
- The scope in which to define the constructor.clazz
- The Java class to use to define the JavaScript objects
and properties. The class must implement Scriptable.sealed
- Whether or not to create sealed standard objects that
cannot be modified.
defineClass
public static String defineClass(Scriptable scope,
Class clazz,
boolean sealed,
boolean mapInheritance)
throws IllegalAccessException,
InstantiationException,
InvocationTargetException
Defines JavaScript objects from a Java class, optionally
allowing sealing and mapping of Java inheritance to JavaScript
prototype-based inheritance.
Similar to defineClass(Scriptable scope, Class clazz)
except that sealing and inheritance mapping are allowed. An object
that is sealed cannot have properties added or removed. Note that
sealing is not allowed in the current ECMA/ISO language specification,
but is likely for the next version.
scope
- The scope in which to define the constructor.clazz
- The Java class to use to define the JavaScript objects
and properties. The class must implement Scriptable.sealed
- Whether or not to create sealed standard objects that
cannot be modified.mapInheritance
- Whether or not to map Java inheritance to
JavaScript prototype-based inheritance.
- the class name for the prototype of the specified class
defineFunctionProperties
public void defineFunctionProperties(String[] names,
Class clazz,
int attributes)
Search for names in a class, adding the resulting methods
as properties.
Uses reflection to find the methods of the given names. Then
FunctionObjects are constructed from the methods found, and
are added to this object as properties with the given names.
names
- the names of the Methods to add as function propertiesclazz
- the class to search for the Methodsattributes
- the attributes of the new properties
defineProperty
public void defineProperty(String propertyName,
Class clazz,
int attributes)
Define a JavaScript property with getter and setter side effects.
If the setter is not found, the attribute READONLY is added to
the given attributes.
The getter must be a method with zero parameters, and the setter, if
found, must be a method with one parameter.
propertyName
- the name of the property to define. This name
also affects the name of the setter and getter
to search for. If the propertyId is "foo", then
clazz
will be searched for "getFoo"
and "setFoo" methods.clazz
- the Java class to search for the getter and setterattributes
- the attributes of the JavaScript property
org.mozilla.javascript.Scriptable.put
defineProperty
public void defineProperty(String propertyName,
Object delegateTo,
Method getter,
Method setter,
int attributes)
Define a JavaScript property.
Use this method only if you wish to define getters and setters for
a given property in a ScriptableObject. To create a property without
special getter or setter side effects, use
defineProperty(String,int)
.
If
setter
is null, the attribute READONLY is added to
the given attributes.
Several forms of getters or setters are allowed. In all cases the
type of the value parameter can be any one of the following types:
Object, String, boolean, Scriptable, byte, short, int, long, float,
or double. The runtime will perform appropriate conversions based
upon the type of the parameter (see description in FunctionObject).
The first forms are nonstatic methods of the class referred to
by 'this':
Object getFoo();
void setFoo(SomeType value);
Next are static methods that may be of any class; the object whose
property is being accessed is passed in as an extra argument:
static Object getFoo(ScriptableObject obj);
static void setFoo(ScriptableObject obj, SomeType value);
Finally, it is possible to delegate to another object entirely using
the
delegateTo
parameter. In this case the methods are
nonstatic methods of the class delegated to, and the object whose
property is being accessed is passed in as an extra argument:
Object getFoo(ScriptableObject obj);
void setFoo(ScriptableObject obj, SomeType value);
propertyName
- the name of the property to define.delegateTo
- an object to call the getter and setter methods on,
or null, depending on the form used above.getter
- the method to invoke to get the value of the propertysetter
- the method to invoke to set the value of the propertyattributes
- the attributes of the JavaScript property
defineProperty
public void defineProperty(String propertyName,
Object value,
int attributes)
Define a JavaScript property.
Creates the property with an initial value and sets its attributes.
propertyName
- the name of the property to define.value
- the initial value of the propertyattributes
- the attributes of the JavaScript property
org.mozilla.javascript.Scriptable.put
defineProperty
public static void defineProperty(Scriptable destination,
String propertyName,
Object value,
int attributes)
Utility method to add properties to arbitrary Scriptable object.
If destination is instance of ScriptableObject, calls
defineProperty there, otherwise calls put in destination
ignoring attributes
delete
public void delete(String name)
Removes a named property from the object.
If the property is not found, or it has the PERMANENT attribute,
no action is taken.
- delete in interface Scriptable
name
- the name of the property
delete
public void delete(int index)
Removes the indexed property from the object.
If the property is not found, or it has the PERMANENT attribute,
no action is taken.
- delete in interface Scriptable
index
- the numeric index for the property
deleteProperty
public static boolean deleteProperty(Scriptable obj,
String name)
Removes the property from an object or its prototype chain.
Searches for a property with
name
in obj or
its prototype chain. If it is found, the object's delete
method is called.
obj
- a JavaScript objectname
- a property name
- true if the property doesn't exist or was successfully removed
deleteProperty
public static boolean deleteProperty(Scriptable obj,
int index)
Removes the property from an object or its prototype chain.
Searches for a property with
index
in obj or
its prototype chain. If it is found, the object's delete
method is called.
obj
- a JavaScript objectindex
- a property index
- true if the property doesn't exist or was successfully removed
equivalentValues
protected Object equivalentValues(Object value)
Custom
== operator.
Must return
Scriptable.NOT_FOUND
if this object does not
have custom equality operator for the given value,
Boolean.TRUE if this object is equivalent to
value,
Boolean.FALSE if this object is not equivalent to
value.
The default implementation returns Boolean.TRUE
if
this == value or
Scriptable.NOT_FOUND
otherwise.
It indicates that by default custom equality is available only if
value is
this in which case true is returned.
get
public Object get(String name,
Scriptable start)
Returns the value of the named property or NOT_FOUND.
If the property was created using defineProperty, the
appropriate getter method is called.
- get in interface Scriptable
name
- the name of the propertystart
- the object in which the lookup began
- the value of the property (may be null), or NOT_FOUND
get
public Object get(int index,
Scriptable start)
Returns the value of the indexed property or NOT_FOUND.
- get in interface Scriptable
index
- the numeric index for the propertystart
- the object in which the lookup began
- the value of the property (may be null), or NOT_FOUND
getAllIds
public Object[] getAllIds()
Returns an array of ids for the properties of the object.
All properties, even those with attribute DONTENUM, are listed.
- getAllIds in interface DebuggableObject
- an array of java.lang.Objects with an entry for every
listed property. Properties accessed via an integer index will
have a corresponding
Integer entry in the returned array. Properties accessed by
a String will have a String entry in the returned array.
getAssociatedValue
public final Object getAssociatedValue(Object key)
Get arbitrary application-specific value associated with this object.
key
- key object to select particular value.
associateValue(Object key, Object value)
getAttributes
public int getAttributes(String name)
Get the attributes of a named property.
The property is specified by
name
as defined for
has
.
name
- the identifier for the property
getAttributes
public final int getAttributes(String name,
Scriptable start)
Use getAttributes(String name)
. The engine always
ignored the start argument.
getAttributes
public int getAttributes(int index)
Get the attributes of an indexed property.
index
- the numeric index for the property
getAttributes
public final int getAttributes(int index,
Scriptable start)
Use getAttributes(int index)
. The engine always
ignored the start argument.
getClassName
public abstract String getClassName()
Return the name of the class.
This is typically the same name as the constructor.
Classes extending ScriptableObject must implement this abstract
method.
- getClassName in interface Scriptable
getClassPrototype
public static Scriptable getClassPrototype(Scriptable scope,
String className)
Get the prototype for the named class.
For example, getClassPrototype(s, "Date")
will first
walk up the parent chain to find the outermost scope, then will
search that scope for the Date constructor, and then will
return Date.prototype. If any of the lookups fail, or
the prototype is not a JavaScript object, then null will
be returned.
scope
- an object in the scope chainclassName
- the name of the constructor
- the prototype for the named class, or null if it
cannot be found.
getDefaultValue
public Object getDefaultValue(Class typeHint)
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".
- getDefaultValue in interface Scriptable
- the default value for the object
See ECMA 8.6.2.6.
getFunctionPrototype
public static Scriptable getFunctionPrototype(Scriptable scope)
Get the Function.prototype property.
See ECMA 15.3.4.
getIds
public Object[] getIds()
Returns an array of ids for the properties of the object.
Any properties with the attribute DONTENUM are not listed.
- getIds in interface Scriptable
- an array of java.lang.Objects with an entry for every
listed property. Properties accessed via an integer index will
have a corresponding
Integer entry in the returned array. Properties accessed by
a String will have a String entry in the returned array.
getObjectPrototype
public static Scriptable getObjectPrototype(Scriptable scope)
Get the Object.prototype property.
See ECMA 15.2.4.
getProperty
public static Object getProperty(Scriptable obj,
String name)
Gets a named property from an object or any object in its prototype chain.
Searches the prototype chain for a property named
name
.
obj
- a JavaScript objectname
- a property name
- the value of a property with name
name
found in
obj
or any object in its prototype chain, or
Scriptable.NOT_FOUND
if not found
getProperty
public static Object getProperty(Scriptable obj,
int index)
Gets an indexed property from an object or any object in its prototype chain.
Searches the prototype chain for a property with integral index
index
. Note that if you wish to look for properties with numerical
but non-integral indicies, you should use getProperty(Scriptable,String) with
the string value of the index.
obj
- a JavaScript objectindex
- an integral index
- the value of a property with index
index
found in
obj
or any object in its prototype chain, or
Scriptable.NOT_FOUND
if not found
getPropertyIds
public static Object[] getPropertyIds(Scriptable obj)
Returns an array of all ids from an object and its prototypes.
obj
- a JavaScript object
- an array of all ids from all object in the prototype chain.
If a given id occurs multiple times in the prototype chain,
it will occur only once in this list.
getTopLevelScope
public static Scriptable getTopLevelScope(Scriptable obj)
Get the global scope.
Walks the parent scope chain to find an object with a null
parent scope (the global object).
obj
- a JavaScript object
- the corresponding global scope
getTopScopeValue
public static Object getTopScopeValue(Scriptable scope,
Object key)
Get arbitrary application-specific value associated with the top scope
of the given scope.
The method first calls getTopLevelScope(Scriptable scope)
and then searches the prototype chain of the top scope for the first
object containing the associated value with the given key.
scope
- the starting scope.key
- key object to select particular value.
getAssociatedValue(Object key)
has
public boolean has(String name,
Scriptable start)
Returns true if the named property is defined.
- has in interface Scriptable
name
- the name of the propertystart
- the object in which the lookup began
- true if and only if the property was found in the object
has
public boolean has(int index,
Scriptable start)
Returns true if the property index is defined.
- has in interface Scriptable
index
- the numeric index for the propertystart
- the object in which the lookup began
- true if and only if the property was found in the object
hasInstance
public boolean hasInstance(Scriptable instance)
Implements the instanceof operator.
This operator has been proposed to ECMA.
- hasInstance in interface Scriptable
instance
- The value that appeared on the LHS of the instanceof
operator
- true if "this" appears in value's prototype chain
hasProperty
public static boolean hasProperty(Scriptable obj,
String name)
Returns whether a named property is defined in an object or any object
in its prototype chain.
Searches the prototype chain for a property named
name
.
obj
- a JavaScript objectname
- a property name
- the true if property was found
hasProperty
public static boolean hasProperty(Scriptable obj,
int index)
Returns whether an indexed property is defined in an object or any object
in its prototype chain.
Searches the prototype chain for a property with index
index
.
obj
- a JavaScript objectindex
- a property index
- the true if property was found
isSealed
public final boolean isSealed()
Return true if this object is sealed.
It is an error to attempt to add or remove properties to
a sealed object.
- true if sealed, false otherwise.
put
public void put(String name,
Scriptable start,
Object value)
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.
- put in interface Scriptable
name
- the name of the propertystart
- the object whose property is being setvalue
- value to set the property to
put
public void put(int index,
Scriptable start,
Object value)
Sets the value of the indexed property, creating it if need be.
- put in interface Scriptable
index
- the numeric index for the propertystart
- the object whose property is being setvalue
- value to set the property to
putProperty
public static void putProperty(Scriptable obj,
String name,
Object value)
Puts a named property in an object or in an object in its prototype chain.
Seaches for the named property in the prototype chain. If it is found,
the value of the property in
obj
is changed through a call
to
Scriptable.put(String,Scriptable,Object)
on the prototype
passing
obj
as the
start
argument. This allows
the prototype to veto the property setting in case the prototype defines
the property with [[ReadOnly]] attribute. If the property is not found,
it is added in
obj
.
obj
- a JavaScript objectname
- a property namevalue
- any JavaScript value accepted by Scriptable.put
putProperty
public static void putProperty(Scriptable obj,
int index,
Object value)
Puts an indexed property in an object or in an object in its prototype chain.
Seaches for the indexed property in the prototype chain. If it is found,
the value of the property in
obj
is changed through a call
to
Scriptable.put(int,Scriptable,Object)
on the prototype
passing
obj
as the
start
argument. This allows
the prototype to veto the property setting in case the prototype defines
the property with [[ReadOnly]] attribute. If the property is not found,
it is added in
obj
.
obj
- a JavaScript objectindex
- a property indexvalue
- any JavaScript value accepted by Scriptable.put
sealObject
public void sealObject()
Seal this object.
A sealed object may not have properties added or removed. Once
an object is sealed it may not be unsealed.
setAttributes
public void setAttributes(String name,
int attributes)
Set the attributes of a named property.
The property is specified by
name
as defined for
has
.
The possible attributes are READONLY, DONTENUM,
and PERMANENT. Combinations of attributes
are expressed by the bitwise OR of attributes.
EMPTY is the state of no attributes set. Any unused
bits are reserved for future use.
name
- the name of the propertyattributes
- the bitset of attributes
setAttributes
public final void setAttributes(String name,
Scriptable start,
int attributes)
Use setAttributes(String name, int attributes)
.
The engine always ignored the start argument.
setAttributes
public void setAttributes(int index,
int attributes)
Set the attributes of an indexed property.
index
- the numeric index for the propertyattributes
- the bitset of attributes
setAttributes
public void setAttributes(int index,
Scriptable start,
int attributes)
Use setAttributes(int index, int attributes)
.
The engine always ignored the start argument.