KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > quercus > env > Callback


1 /*
2  * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3  *
4  * This file is part of Resin(R) Open Source
5  *
6  * Each copy or derived work must preserve the copyright notice and this
7  * notice unmodified.
8  *
9  * Resin Open Source is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * Resin Open Source is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17  * of NON-INFRINGEMENT. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Resin Open Source; if not, write to the
22  *
23  * Free Software Foundation, Inc.
24  * 59 Temple Place, Suite 330
25  * Boston, MA 02111-1307 USA
26  *
27  * @author Scott Ferguson
28  */
29
30 package com.caucho.quercus.env;
31
32 /**
33  * Represents a call to a function.
34  */
35 abstract public class Callback extends Value {
36   /**
37    * Evaluates the callback with no arguments.
38    *
39    * @param env the calling environment
40    */
41   abstract public Value call(Env env);
42
43   /**
44    * Evaluates the callback with 1 arguments.
45    *
46    * @param env the calling environment
47    */
48   abstract public Value call(Env env, Value a1);
49
50   /**
51    * Evaluates the callback with 2 arguments.
52    *
53    * @param env the calling environment
54    */
55   abstract public Value call(Env env, Value a1, Value a2);
56
57   /**
58    * Evaluates the callback with 3 arguments.
59    *
60    * @param env the calling environment
61    */
62   abstract public Value call(Env env, Value a1, Value a2, Value a3);
63
64   /**
65    * Evaluates the callback with 4 arguments.
66    *
67    * @param env the calling environment
68    */
69   abstract public Value call(Env env, Value a1, Value a2, Value a3,
70                              Value a4);
71
72   /**
73    * Evaluates the callback with 5 arguments.
74    *
75    * @param env the calling environment
76    */
77   abstract public Value call(Env env, Value a1, Value a2, Value a3,
78                              Value a4, Value a5);
79
80   /**
81    * Evaluates the callback with variable arguments.
82    *
83    * @param env the calling environment
84    */
85   abstract public Value call(Env env, Value []args);
86
87   /**
88    *
89    * @return true if this is an invalid callback reference
90    */
91   abstract public boolean isValid();
92
93   /**
94    * Returns the name of the callback.
95    *
96    */
97   abstract public String JavaDoc getCallbackName();
98
99   /**
100    * Returns true if this callback is implemented internally (i.e. in Java).
101    *
102    */
103   abstract public boolean isInternal();
104 }
105
106
Popular Tags