Package org.mozilla.javascript

Class FunctionObject

    • Constructor Detail

      • FunctionObject

        public FunctionObject​(java.lang.String name,
                      java.lang.reflect.Member methodOrConstructor,
                      Scriptable scope)
        Create a JavaScript function object from a Java method.

        The member argument must be either a java.lang.reflect.Method or a java.lang.reflect.Constructor and must match one of two forms.

        The first form is a member with zero or more parameters of the following types: Object, String, boolean, Scriptable, int, or double. The Long type is not supported because the double representation of a long (which is the EMCA-mandated storage type for Numbers) may lose precision. If the member is a Method, the return value must be void or one of the types allowed for parameters.

        The runtime will perform appropriate conversions based upon the type of the parameter. A parameter type of Object specifies that no conversions are to be done. A parameter of type String will use Context.toString to convert arguments. Similarly, parameters of type double, boolean, and Scriptable will cause Context.toNumber, Context.toBoolean, and Context.toObject, respectively, to be called.

        If the method is not static, the Java 'this' value will correspond to the JavaScript 'this' value. Any attempt to call the function with a 'this' value that is not of the right Java type will result in an error.

        The second form is the variable arguments (or "varargs") form. If the FunctionObject will be used as a constructor, the member must have the following parameters 

              (Context cx, Object[] args, Function ctorObj,
       boolean inNewExpr)
        and if it is a Method, be static and return an Object result.

        Otherwise, if the FunctionObject will not be used to define a constructor, the member must be a static Method with parameters 

              (Context cx, Scriptable thisObj, Object[] args,
       Function funObj)
        and an Object result.

        When the function varargs form is called as part of a function call, the args parameter contains the arguments, with thisObj set to the JavaScript 'this' value. funObj is the function object for the invoked function.

        When the constructor varargs form is called or invoked while evaluating a new expression, args contains the arguments, ctorObj refers to this FunctionObject, and inNewExpr is true if and only if a new expression caused the call. This supports defining a function that has different behavior when called as a constructor than when invoked as a normal function call. (For example, the Boolean constructor, when called as a function, will convert to boolean rather than creating a new object.)

        Parameters:
        name - the name of the function
        methodOrConstructor - a java.lang.reflect.Method or a java.lang.reflect.Constructor that defines the object
        scope - enclosing scope of function
        See Also:
        Scriptable

    • Method Detail

      • getTypeTag

        public static int getTypeTag​(java.lang.Class<?> type)
        Returns:
        One of JAVA_*_TYPE constants to indicate desired type or JAVA_UNSUPPORTED_TYPE if the convertion is not possible

      • convertArg

        public static java.lang.Object convertArg​(Context cx,
                                          Scriptable scope,
                                          java.lang.Object arg,
                                          int typeTag)

      • getArity

        public int getArity()
        Return the value defined by the method used to construct the object (number of parameters of the method, or 1 if the method is a "varargs" form).
        Overrides:
        getArity in class BaseFunction

      • getMethodOrConstructor

        public java.lang.reflect.Member getMethodOrConstructor()
        Get Java method or constructor this function represent.

      • call

        public java.lang.Object call​(Context cx,
                             Scriptable scope,
                             Scriptable thisObj,
                             java.lang.Object[] args)
        Performs conversions on argument types if needed and invokes the underlying Java method or constructor.

        Implements Function.call.

        Specified by:
        call in interface Callable
        Specified by:
        call in interface Function
        Overrides:
        call in class BaseFunction
        Parameters:
        cx - the current Context for this thread
        scope - the scope to execute the function relative to. This is set to the value returned by getParentScope() except when the function is called from a closure.
        thisObj - the JavaScript this object
        args - the array of arguments
        Returns:
        the result of the call
        See Also:
        Function.call( Context, Scriptable, Scriptable, Object[])

      • createObject

        public Scriptable createObject​(Context cx,
                               Scriptable scope)
        Return new Scriptable instance using the default constructor for the class of the underlying Java method. Return null to indicate that the call method should be used to create new objects.
        Overrides:
        createObject in class BaseFunction