mnj/lua/LuaJavaCallback.java

   1 /*  $Header: //info.ravenbrook.com/project/jili/version/1.1/code/mnj/lua/LuaJavaCallback.java#1 $
   2  * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
   3  * All rights reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject
  11  * to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  21  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 // Modified 2009-12-26 by Ilari Liusvaara
  26 // Make luaFunction public, because it can't be overridden outside
  27 // package otherwise.
  28
  29 package mnj.lua;
  30
  31 /**
  32  * Common superclass for all Lua Java Functions.  A Lua function that
  33  * is implemented in Java is called a Lua Java Function.  Each such
  34  * function corresponds to an indirect instance of this class.  If you
  35  * wish to implement your own Lua Java Function then you'll need to
  36  * subclass this class and have one instance for each function that you
  37  * need.  It is recommended that you extend the class with at least one
  38  * member so that you can distinguish the different instances.  Whilst
  39  * it is possible to implement each different Lua Java Function by
  40  * having a new subclass for each one, this is not recommended as it
  41  * will increase the size of the resulting <code>.jar</code> file by a
  42  * large amount.
  43  */
  44 public abstract class LuaJavaCallback
  45 {
  46   public abstract int luaFunction(Lua L);
  47 }