java.lang.Object
org.openjdk.nashorn.api.scripting.AbstractJSObject
org.openjdk.nashorn.api.scripting.ScriptObjectMirror
Mirror object that wraps a given Nashorn Script object.
- Since:
- 1.8u40
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionCall this object as a JavaScript function.callMember
(String functionName, Object... args) Call member functionvoid
clear()
boolean
containsKey
(Object key) boolean
containsValue
(Object value) boolean
Delete a property from this object.entrySet()
boolean
Evaluate a JavaScript expression.freeze()
ECMA 15.2.39 - freeze implementation.ECMA [[Class]] propertygetDefaultValue
(Class<?> hint) Implements this object's[[DefaultValue]]
method as per ECMAScript 5.1 section 8.6.2.Retrieves a named member of this JavaScript object.String[]
getOwnKeys
(boolean all) return an array of own property keys associated with the object.ECMA 8.12.1 [[GetOwnProperty]] (P)getProto()
Return the __proto__ of this object.getSlot
(int index) Retrieves an indexed member of this JavaScript object.int
hashCode()
boolean
Does this object have a named member?boolean
hasSlot
(int slot) Does this object have a indexed property?static boolean
Are the given objects mirrors to same underlying object?boolean
isArray()
Is this an array object?boolean
isEmpty()
boolean
Check if this script object is extensibleboolean
isFrozen()
Check whether this script object is frozenboolean
Is this a function object?boolean
isInstance
(Object instance) Checking whether the given object is an instance of 'this' object.boolean
isSealed()
Check whether this script object is sealedboolean
Is this a 'use strict' function object?static boolean
isUndefined
(Object obj) Utility to check if given object is ECMAScript undefined valuekeySet()
Returns the set of all property names of this object.Call this 'constructor' JavaScript function to create a new object.Flag this script object as non extensiblevoid
void
removeMember
(String name) Remove a named member from this JavaScript objectseal()
ECMAScript 15.2.3.8 - seal implementationvoid
Nashorn extension: setIndexedPropertiesToExternalArrayData.void
Set a named member in this JavaScript objectvoid
Set the __proto__ of this object.void
Set an indexed member in this JavaScript objectint
size()
<T> T
Utility to convert this script object to the given type.double
toNumber()
Deprecated.toString()
static Object
Unwrap a script object mirror if needed.static Object[]
unwrapArray
(Object[] args, Object homeGlobal) Unwrap an array of script object mirrors if needed.values()
Returns the set of all property values of this object.static Object
Make a script object mirror on given object if needed.static Object[]
Wrap an array of object to script object mirrors if needed.static Object
wrapAsJSONCompatible
(Object obj, Object homeGlobal) Make a script object mirror on given object if needed.Methods inherited from class org.openjdk.nashorn.api.scripting.AbstractJSObject
getDefaultValue, isInstanceOf
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Method Details
-
equals
-
hashCode
public int hashCode() -
toString
-
call
Description copied from interface:JSObject
Call this object as a JavaScript function. This is equivalent to 'func.apply(thiz, args)' in JavaScript.- Specified by:
call
in interfaceJSObject
- Overrides:
call
in classAbstractJSObject
- Parameters:
thiz
- 'this' object to be passed to the function. This may be null.args
- arguments to method- Returns:
- result of call
-
newObject
Description copied from interface:JSObject
Call this 'constructor' JavaScript function to create a new object. This is equivalent to 'new func(arg1, arg2...)' in JavaScript.- Specified by:
newObject
in interfaceJSObject
- Overrides:
newObject
in classAbstractJSObject
- Parameters:
args
- arguments to method- Returns:
- result of constructor call
-
eval
Description copied from interface:JSObject
Evaluate a JavaScript expression.- Specified by:
eval
in interfaceJSObject
- Overrides:
eval
in classAbstractJSObject
- Parameters:
s
- JavaScript expression to evaluate- Returns:
- evaluation result
-
callMember
Call member function- Parameters:
functionName
- function nameargs
- arguments- Returns:
- return value of function
-
getMember
Description copied from interface:JSObject
Retrieves a named member of this JavaScript object.- Specified by:
getMember
in interfaceJSObject
- Overrides:
getMember
in classAbstractJSObject
- Parameters:
name
- of member- Returns:
- member
-
getSlot
Description copied from interface:JSObject
Retrieves an indexed member of this JavaScript object.- Specified by:
getSlot
in interfaceJSObject
- Overrides:
getSlot
in classAbstractJSObject
- Parameters:
index
- index slot to retrieve- Returns:
- member
-
hasMember
Description copied from interface:JSObject
Does this object have a named member?- Specified by:
hasMember
in interfaceJSObject
- Overrides:
hasMember
in classAbstractJSObject
- Parameters:
name
- name of member- Returns:
- true if this object has a member of the given name
-
hasSlot
public boolean hasSlot(int slot) Description copied from interface:JSObject
Does this object have a indexed property?- Specified by:
hasSlot
in interfaceJSObject
- Overrides:
hasSlot
in classAbstractJSObject
- Parameters:
slot
- index to check- Returns:
- true if this object has a slot
-
removeMember
Description copied from interface:JSObject
Remove a named member from this JavaScript object- Specified by:
removeMember
in interfaceJSObject
- Overrides:
removeMember
in classAbstractJSObject
- Parameters:
name
- name of the member
-
setMember
Description copied from interface:JSObject
Set a named member in this JavaScript object- Specified by:
setMember
in interfaceJSObject
- Overrides:
setMember
in classAbstractJSObject
- Parameters:
name
- name of the membervalue
- value of the member
-
setSlot
Description copied from interface:JSObject
Set an indexed member in this JavaScript object- Specified by:
setSlot
in interfaceJSObject
- Overrides:
setSlot
in classAbstractJSObject
- Parameters:
index
- index of the member slotvalue
- value of the member
-
setIndexedPropertiesToExternalArrayData
Nashorn extension: setIndexedPropertiesToExternalArrayData. set indexed properties be exposed from a given nio ByteBuffer.- Parameters:
buf
- external buffer - should be a nio ByteBuffer
-
isInstance
Description copied from interface:JSObject
Checking whether the given object is an instance of 'this' object.- Specified by:
isInstance
in interfaceJSObject
- Overrides:
isInstance
in classAbstractJSObject
- Parameters:
instance
- instance to check- Returns:
- true if the given 'instance' is an instance of this 'function' object
-
getClassName
Description copied from interface:JSObject
ECMA [[Class]] property- Specified by:
getClassName
in interfaceJSObject
- Overrides:
getClassName
in classAbstractJSObject
- Returns:
- ECMA [[Class]] property value of this object
-
isFunction
public boolean isFunction()Description copied from interface:JSObject
Is this a function object?- Specified by:
isFunction
in interfaceJSObject
- Overrides:
isFunction
in classAbstractJSObject
- Returns:
- if this mirror wraps a ECMAScript function instance
-
isStrictFunction
public boolean isStrictFunction()Description copied from interface:JSObject
Is this a 'use strict' function object?- Specified by:
isStrictFunction
in interfaceJSObject
- Overrides:
isStrictFunction
in classAbstractJSObject
- Returns:
- true if this mirror represents a ECMAScript 'use strict' function
-
isArray
public boolean isArray()Description copied from interface:JSObject
Is this an array object?- Specified by:
isArray
in interfaceJSObject
- Overrides:
isArray
in classAbstractJSObject
- Returns:
- if this mirror wraps a ECMAScript array object
-
clear
public void clear() -
containsKey
- Specified by:
containsKey
in interfaceBindings
- Specified by:
containsKey
in interfaceMap<String,
Object>
-
containsValue
- Specified by:
containsValue
in interfaceMap<String,
Object>
-
entrySet
-
get
-
isEmpty
public boolean isEmpty() -
keySet
Description copied from interface:JSObject
Returns the set of all property names of this object. -
put
-
putAll
-
remove
-
delete
Delete a property from this object.- Parameters:
key
- the property to be deleted- Returns:
- if the delete was successful or not
-
size
public int size() -
values
Description copied from interface:JSObject
Returns the set of all property values of this object. -
getProto
Return the __proto__ of this object.- Returns:
- __proto__ object.
-
setProto
Set the __proto__ of this object.- Parameters:
proto
- new proto for this object
-
getOwnPropertyDescriptor
ECMA 8.12.1 [[GetOwnProperty]] (P)- Parameters:
key
- property key- Returns:
- Returns the Property Descriptor of the named own property of this object, or undefined if absent.
-
getOwnKeys
return an array of own property keys associated with the object.- Parameters:
all
- True if to include non-enumerable keys.- Returns:
- Array of keys.
-
preventExtensions
Flag this script object as non extensible- Returns:
- the object after being made non extensible
-
isExtensible
public boolean isExtensible()Check if this script object is extensible- Returns:
- true if extensible
-
seal
ECMAScript 15.2.3.8 - seal implementation- Returns:
- the sealed script object
-
isSealed
public boolean isSealed()Check whether this script object is sealed- Returns:
- true if sealed
-
freeze
ECMA 15.2.39 - freeze implementation. Freeze this script object- Returns:
- the frozen script object
-
isFrozen
public boolean isFrozen()Check whether this script object is frozen- Returns:
- true if frozen
-
isUndefined
Utility to check if given object is ECMAScript undefined value- Parameters:
obj
- object to check- Returns:
- true if 'obj' is ECMAScript undefined value
-
to
Utility to convert this script object to the given type.- Type Parameters:
T
- destination type to convert to- Parameters:
type
- destination type to convert to- Returns:
- converted object
-
wrap
Make a script object mirror on given object if needed.- Parameters:
obj
- object to be wrapped/convertedhomeGlobal
- global to which this object belongs.- Returns:
- wrapped/converted object
-
wrapAsJSONCompatible
Make a script object mirror on given object if needed. The created wrapper will implement the JavaList
interface ifobj
is a JavaScriptArray
object; this is compatible with Java JSON libraries expectations. Arrays retrieved through its properties (transitively) will also implement the list interface.- Parameters:
obj
- object to be wrapped/convertedhomeGlobal
- global to which this object belongs.- Returns:
- wrapped/converted object
-
unwrap
Unwrap a script object mirror if needed.- Parameters:
obj
- object to be unwrappedhomeGlobal
- global to which this object belongs- Returns:
- unwrapped object
-
wrapArray
Wrap an array of object to script object mirrors if needed.- Parameters:
args
- array to be unwrappedhomeGlobal
- global to which this object belongs- Returns:
- wrapped array
-
unwrapArray
Unwrap an array of script object mirrors if needed.- Parameters:
args
- array to be unwrappedhomeGlobal
- global to which this object belongs- Returns:
- unwrapped array
-
identical
Are the given objects mirrors to same underlying object?- Parameters:
obj1
- first objectobj2
- second object- Returns:
- true if obj1 and obj2 are identical script objects or mirrors of it.
-
toNumber
Deprecated.Description copied from class:AbstractJSObject
Returns this object's numeric value.- Specified by:
toNumber
in interfaceJSObject
- Overrides:
toNumber
in classAbstractJSObject
- Returns:
- this object's numeric value.
-
getDefaultValue
Description copied from interface:JSObject
Implements this object's[[DefaultValue]]
method as per ECMAScript 5.1 section 8.6.2.- Specified by:
getDefaultValue
in interfaceJSObject
- Parameters:
hint
- the type hint. Should be eithernull
,Number.class
orString.class
.- Returns:
- this object's default value.
-