src/org/mozilla/javascript/Function.java

   1 /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-\r
   2  *\r
   3  * The contents of this file are subject to the Netscape Public\r
   4  * License Version 1.1 (the "License"); you may not use this file\r
   5  * except in compliance with the License. You may obtain a copy of\r
   6  * the License at http://www.mozilla.org/NPL/\r
   7  *\r
   8  * Software distributed under the License is distributed on an "AS\r
   9  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr\r
  10  * implied. See the License for the specific language governing\r
  11  * rights and limitations under the License.\r
  12  *\r
  13  * The Original Code is Rhino code, released\r
  14  * May 6, 1999.\r
  15  *\r
  16  * The Initial Developer of the Original Code is Netscape\r
  17  * Communications Corporation.  Portions created by Netscape are\r
  18  * Copyright (C) 1997-1999 Netscape Communications Corporation. All\r
  19  * Rights Reserved.\r
  20  *\r
  21  * Contributor(s): \r
  22  * Norris Boyd\r
  23  *\r
  24  * Alternatively, the contents of this file may be used under the\r
  25  * terms of the GNU Public License (the "GPL"), in which case the\r
  26  * provisions of the GPL are applicable instead of those above.\r
  27  * If you wish to allow use of your version of this file only\r
  28  * under the terms of the GPL and not to allow others to use your\r
  29  * version of this file under the NPL, indicate your decision by\r
  30  * deleting the provisions above and replace them with the notice\r
  31  * and other provisions required by the GPL.  If you do not delete\r
  32  * the provisions above, a recipient may use your version of this\r
  33  * file under either the NPL or the GPL.\r
  34  */\r
  35 \r
  36 // API class\r
  37 \r
  38 package org.mozilla.javascript;\r
  39 \r
  40 /**\r
  41  * This is interface that all functions in JavaScript must implement.\r
  42  * The interface provides for calling functions and constructors.\r
  43  *\r
  44  * @see org.mozilla.javascript.Scriptable\r
  45  * @author Norris Boyd\r
  46  */\r
  47 \r
  48 public interface Function extends Scriptable {\r
  49     /**\r
  50      * Call the function.\r
  51      *\r
  52      * Note that the array of arguments is not guaranteed to have\r
  53      * length greater than 0.\r
  54      *\r
  55      * @param cx the current Context for this thread\r
  56      * @param scope the scope to execute the function relative to. This is\r
  57      *              set to the value returned by getParentScope() except\r
  58      *              when the function is called from a closure.\r
  59      * @param thisObj the JavaScript <code>this</code> object\r
  60      * @param args the array of arguments\r
  61      * @return the result of the call\r
  62      * @exception JavaScriptException if an uncaught exception\r
  63      *            occurred while executing the function\r
  64      */\r
  65     public Object call(Context cx, Scriptable scope, Scriptable thisObj,\r
  66                        Object[] args)\r
  67         throws JavaScriptException;\r
  68 \r
  69     /**\r
  70      * Call the function as a constructor.\r
  71      *\r
  72      * This method is invoked by the runtime in order to satisfy a use\r
  73      * of the JavaScript <code>new</code> operator.  This method is\r
  74      * expected to create a new object and return it.\r
  75      *\r
  76      * @param cx the current Context for this thread\r
  77      * @param scope an enclosing scope of the caller except\r
  78      *              when the function is called from a closure.\r
  79      * @param args the array of arguments\r
  80      * @return the allocated object\r
  81      * @exception JavaScriptException if an uncaught exception\r
  82      *            occurred while executing the constructor\r
  83      */\r
  84     public Scriptable construct(Context cx, Scriptable scope, Object[] args)\r
  85         throws JavaScriptException;\r
  86 }\r