src/org/mozilla/javascript/WrapHandler.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-2000 Netscape Communications Corporation. All\r
  19  * Rights Reserved.\r
  20  *\r
  21  * Contributor(s): \r
  22  * Marshall Cline\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  * Embeddings that wish to provide their own custom wrappings for Java\r
  42  * objects may implement this interface and call Context.setWrapHandler.\r
  43  * @see org.mozilla.javascript.Context#setWrapHandler\r
  44  */\r
  45 public interface WrapHandler {\r
  46 \r
  47     /**\r
  48      * Wrap the object.\r
  49      * <p>\r
  50      * The value returned must be one of \r
  51      * <UL>\r
  52      * <LI>java.lang.Boolean</LI>\r
  53      * <LI>java.lang.String</LI>\r
  54      * <LI>java.lang.Number</LI>\r
  55      * <LI>org.mozilla.javascript.Scriptable objects</LI>\r
  56      * <LI>The value returned by Context.getUndefinedValue()</LI>\r
  57      * <LI>null</LI>\r
  58      * <p>\r
  59      * If null is returned, the value obj will be wrapped as if \r
  60      * no WrapHandler had been called.\r
  61      * </UL>\r
  62      * @param scope the scope of the executing script\r
  63      * @param obj the object to be wrapped\r
  64      * @staticType the static type of the object to be wrapped\r
  65      * @return the wrapped value.\r
  66      */\r
  67     public Object wrap(Scriptable scope, Object obj, Class staticType);\r
  68 }\r