src/org/mozilla/javascript/Script.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  * All compiled scripts implement this interface.\r
  42  * <p>\r
  43  * This class encapsulates script execution relative to an\r
  44  * object scope.\r
  45  * @since 1.3\r
  46  * @author Norris Boyd\r
  47  */\r
  48 \r
  49 public interface Script {\r
  50 \r
  51     /**\r
  52      * Execute the script.\r
  53      * <p>\r
  54      * The script is executed in a particular runtime Context, which\r
  55      * must be associated with the current thread.\r
  56      * The script is executed relative to a scope--definitions and\r
  57      * uses of global top-level variables and functions will access\r
  58      * properties of the scope object. For compliant ECMA\r
  59      * programs, the scope must be an object that has been initialized\r
  60      * as a global object using <code>Context.initStandardObjects</code>.\r
  61      * <p>\r
  62      *\r
  63      * @param cx the Context associated with the current thread\r
  64      * @param scope the scope to execute relative to\r
  65      * @return the result of executing the script\r
  66      * @see org.mozilla.javascript.Context#initStandardObjects\r
  67      * @exception JavaScriptException if an uncaught JavaScript exception\r
  68      *            occurred while executing the script\r
  69      */\r
  70     public Object exec(Context cx, Scriptable scope)\r
  71         throws JavaScriptException;\r
  72 \r
  73 }\r