org.liquidplayer.javascript

Class JSFunction

java.lang.Object

org.liquidplayer.javascript.JSValue

org.liquidplayer.javascript.JSObject

org.liquidplayer.javascript.JSFunction

Direct Known Subclasses:

JSBaseArray

public class JSFunction
extends JSObject

A JavaScript function object.

Since:

0.1.0

Nested Class Summary

Nested classes/interfaces inherited from class org.liquidplayer.javascript.JSObject

JSObject.jsexport, JSObject.Property<T>

Field Summary

Fields inherited from class org.liquidplayer.javascript.JSObject

JSPropertyAttributeDontDelete, JSPropertyAttributeDontEnum, JSPropertyAttributeNone, JSPropertyAttributeReadOnly

Constructor Summary

Constructors

Constructor and Description
JSFunction(org.liquidplayer.javascript.JNIJSObject objRef, JSContext context) Wraps an existing object as a JSFunction
JSFunction(JSContext ctx) Creates a new function which basically does nothing.
JSFunction(JSContext ctx, java.lang.reflect.Method method) Creates a new function object which calls method 'method' on this Java object.
JSFunction(JSContext ctx, java.lang.reflect.Method method, java.lang.Class<? extends JSObject> instanceClass) Creates a new function object which calls method 'method' on this Java object.
JSFunction(JSContext ctx, java.lang.reflect.Method method, java.lang.Class<? extends JSObject> instanceClass, JSObject invokeObject) Creates a new function object which calls method 'method' on this Java object.
JSFunction(JSContext ctx, java.lang.String methodName) Creates a new function object which calls method 'methodName' on this Java object.
JSFunction(JSContext ctx, java.lang.String methodName, java.lang.Class<? extends JSObject> instanceClass) Creates a new function object which calls method 'methodName' on this Java object.
JSFunction(JSContext ctx, java.lang.String methodName, java.lang.Class<? extends JSObject> instanceClass, JSObject invokeObject) Creates a new function object which calls method 'methodName' on this Java object.
JSFunction(JSContext ctx, java.lang.String name, java.lang.String[] parameterNames, java.lang.String body, java.lang.String sourceURL, int startingLineNumber) Creates a JavaScript function that takes parameters 'parameterNames' and executes the JS code in 'body'.
JSFunction(JSContext ctx, java.lang.String name, java.lang.String body, java.lang.String... parameterNames) Creates a JavaScript function that takes parameters 'parameterNames' and executes the JS code in 'body'.

Method Summary

Modifier and Type	Method and Description
JSValue	apply(JSObject thiz, java.lang.Object[] args) Calls this JavaScript function, similar to 'Function.apply() in JavaScript
JSValue	call() Calls this JavaScript function with no args and 'this' as null
JSValue	call(JSObject thiz, java.lang.Object... args) Calls this JavaScript function, similar to 'Function.call()' in JavaScript
JSObject	newInstance(java.lang.Object... args) Calls this JavaScript function as a constructor, i.e.

Methods inherited from class org.liquidplayer.javascript.JSObject

__nullFunc, deleteProperty, getThis, hashCode, hasProperty, isConstructor, isFunction, property, property, property, propertyAtIndex, propertyAtIndex, propertyNames, prototype, prototype

Methods inherited from class org.liquidplayer.javascript.JSValue

equals, getContext, isArray, isBoolean, isDate, isEqual, isFloat32Array, isFloat64Array, isInstanceOfConstructor, isInt16Array, isInt32Array, isInt8Array, isNull, isNumber, isObject, isStrictEqual, isString, isTypedArray, isUint16Array, isUint32Array, isUint8Array, isUint8ClampedArray, isUndefined, toBoolean, toFunction, toJSArray, toJSON, toNumber, toObject, toString, valueHash, valueRef

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JSFunction

public JSFunction(JSContext ctx,
                  @NonNull
                  java.lang.String name,
                  @NonNull
                  java.lang.String[] parameterNames,
                  @NonNull
                  java.lang.String body,
                  java.lang.String sourceURL,
                  int startingLineNumber)

Creates a JavaScript function that takes parameters 'parameterNames' and executes the JS code in 'body'.

Parameters:

ctx - The JSContext in which to create the function

name - The name of the function

parameterNames - A String array containing the names of the parameters

body - The JavaScript code to execute in the function

sourceURL - The URI of the source file, only used for reporting in stack trace (optional)

startingLineNumber - The beginning line number, only used for reporting in stack trace (optional)

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  @NonNull
                  java.lang.String name,
                  @NonNull
                  java.lang.String body,
                  java.lang.String... parameterNames)

Creates a JavaScript function that takes parameters 'parameterNames' and executes the JS code in 'body'.

Parameters:

ctx - The JSContext in which to create the function

name - The name of the function

parameterNames - A String array containing the names of the parameters

body - The JavaScript code to execute in the function

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  java.lang.reflect.Method method,
                  java.lang.Class<? extends JSObject> instanceClass,
                  JSObject invokeObject)

Creates a new function object which calls method 'method' on this Java object. Assumes the 'method' exists on this object and will throw a JSException if not found. If 'new' is called on this function, it will create a new 'instanceClass' instance. In JS:

 var f = function(a) { ... };
 
 

Example:

 public class FunctionObject extends JSObject {
     void function(int x) {
         getThis().property("varx",x);
     }
 }

 public class MyFunc extends JSFunction {
     MyFunc(JSContext ctx) {
         super(ctx,
              FunctionObject.class.getMethod("function",int.class), // will call method 'function'
              JSObject.class                                // calling 'new' will create a JSObject
              new FunctionObject(ctx)                       // function will be called on FunctionObject
         );
     }
 }
 
 

Parameters:

ctx - The JSContext to create the object in

method - The method to invoke

instanceClass - The class to be created on 'new' call

invokeObject - The object on which to invoke the method

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  java.lang.reflect.Method method,
                  java.lang.Class<? extends JSObject> instanceClass)

Creates a new function object which calls method 'method' on this Java object. Assumes the 'method' exists on this object and will throw a JSException if not found. If 'new' is called on this function, it will create a new 'instanceClass' instance. In JS:

 var f = function(a) { ... };
 
 

Example:

 public class MyFunc extends JSFunction {
     MyFunc(JSContext ctx) {
         super(ctx,
              MyFunc.class.getMethod("function",int.class), // will call method 'function'
              JSObject.class                                // calling 'new' will create a JSObject
         );
     }
     void function(int x) {
         getThis().property("varx",x);
     }
 }
 
 

Parameters:

ctx - The JSContext to create the object in

method - The method to invoke

instanceClass - The class to be created on 'new' call

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  java.lang.reflect.Method method)

Creates a new function object which calls method 'method' on this Java object. Assumes the 'method' exists on this object and will throw a JSException if not found. If 'new' is called on this function, it will create a new JSObject instance. In JS:

 var f = function(a) { ... };
 
 

Example:

 public class MyFunc extends JSFunction {
     MyFunc(JSContext ctx) {
         super(ctx,
              MyFunc.class.getMethod("function",int.class), // will call method 'function'
              JSObject.class                                // calling 'new' will create a JSObject
         );
     }
     void function(int x) {
         getThis().property("varx",x);
     }
 }
 
 

Parameters:

ctx - The JSContext to create the object in

method - The method to invoke

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx)

Creates a new function which basically does nothing. In JS:

 var f = function() {};
 
 

Example:

 JSFunction f = new JSFunction(context);
 
 

Parameters:

ctx - The JSContext to create the object in

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  java.lang.String methodName,
                  java.lang.Class<? extends JSObject> instanceClass,
                  JSObject invokeObject)

Creates a new function object which calls method 'methodName' on this Java object. Assumes the 'methodName' method exists on this object and will throw a JSException if not found. If 'new' is called on this function, it will create a new 'instanceClass' instance. In JS:

 var f = function(a) { ... };
 
 

Example:

 public class FunctionObject extends JSObject {
     void function(int x) {
         getThis().property("varx",x);
     }
 }

 public class MyFunc extends JSFunction {
     MyFunc(JSContext ctx) {
         super(ctx,
              "function",               // will call method 'function'
              JSObject.class            // calling 'new' will create a JSObject
              new FunctionObject(ctx)   // function will be called on FunctionObject
         );
     }
 }
 
 

Parameters:

ctx - The JSContext to create the object in

methodName - The method to invoke (searches for first instance)

instanceClass - The class to be created on 'new' call

invokeObject - The object on which to invoke the method

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  java.lang.String methodName,
                  java.lang.Class<? extends JSObject> instanceClass)

Creates a new function object which calls method 'methodName' on this Java object. Assumes the 'methodName' method exists on this object and will throw a JSException if not found. If 'new' is called on this function, it will create a new JSObject instance. In JS:

 var f = function(a) { ... };
 
 

Example:

 JSFunction f = new JSFunction(context,"function",JSObject.class) {
     void function(int x) {
         getThis().property("varx",x);
     }
 }
 
 

Parameters:

ctx - The JSContext to create the object in

methodName - The method to invoke (searches for first instance)

instanceClass - The class to be created on 'new' call

Since:

0.1.0

JSFunction

public JSFunction(JSContext ctx,
                  java.lang.String methodName)

Creates a new function object which calls method 'methodName' on this Java object. Assumes the 'methodName' method exists on this object and will throw a JSException if not found. If 'new' is called on this function, it will create a new JSObject instance. In JS:

 var f = function(a) { ... };
 
 

Example:

 JSFunction f = new JSFunction(context,"function") {
     void function(int x) {
         getThis().property("varx",x);
     }
 }
 
 

Parameters:

ctx - The JSContext to create the object in

methodName - The method to invoke (searches for first instance)

Since:

0.1.0

JSFunction

public JSFunction(org.liquidplayer.javascript.JNIJSObject objRef,
                  JSContext context)

Wraps an existing object as a JSFunction

Parameters:

objRef - The JavaScriptCore object reference

context - The JSContext the object

Since:

0.1.0

Method Detail

call

public JSValue call(JSObject thiz,
                    java.lang.Object... args)

Calls this JavaScript function, similar to 'Function.call()' in JavaScript

Parameters:

thiz - The 'this' object on which the function operates, null if not on a constructor object

args - The argument list to be passed to the function

Returns:

The JSValue returned by the function

Since:

0.1.0

apply

public JSValue apply(JSObject thiz,
                     java.lang.Object[] args)

Calls this JavaScript function, similar to 'Function.apply() in JavaScript

Parameters:

thiz - The 'this' object on which the function operates, null if not on a constructor object

args - An array of arguments to be passed to the function

Returns:

The JSValue returned by the function

Since:

0.1.0

call

public JSValue call()

Calls this JavaScript function with no args and 'this' as null

Returns:

The JSValue returned by the function

Since:

0.1.0

newInstance

public JSObject newInstance(java.lang.Object... args)

Calls this JavaScript function as a constructor, i.e. same as calling 'new func(args)'

Parameters:

args - The argument list to be passed to the function

Returns:

an instance object of the constructor

Since:

0.1.0