01 
02 /*
03  *  Descripter 1.0 - Java Script Engines
04  *  Copyright (C) 2010-2015  Jianjun Liu (J.J.Liu)
05  *  
06  *  This program is free software: you can redistribute it and/or modify
07  *  it under the terms of the GNU Affero General Public License as published by
08  *  the Free Software Foundation, either version 3 of the License, or
09  *  (at your option) any later version.
10  *  
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU Affero General Public License for more details.
15  *  
16  *  You should have received a copy of the GNU Affero General Public License
17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 package org.descripter.js.api;
21 
22 import org.descripter.js.api.core.CArray;
23 
24 /**
25  * <p>Emulates JavaScript function definitions.</p>
26  * 
27  * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.descripter.org" target="_blank">http://www.descripter.org</a>
28  * @since Descripter 1.0
29  */
30 public abstract class Functor<W extends Script<?>> extends Script<W>
31 {
32     /**
33      * <p>Constructs a script context of this type.</p>
34      * @param function The containing {@link Function} object.
35      * @since Descripter 1.0
36      */
37     protected Functor(Function<W> function) {
38         super(function);
39     }
40 
41     /**
42      * <p>Gets the <tt>arguments</tt> member of the {@link Functor} context.</p>
43      * @return The <tt>arguments</tt> member of the {@link Functor} context
44      * @since Descripter 1.0
45      */
46     public final CArray arguments() {
47         return (CArray)get(core()._arguments);
48     }
49 
50     /**
51      * <p>Gets the <tt>caller</tt> member of the {@link Functor} context.</p>
52      * @return The <tt>caller</tt> member of the {@link Functor} context
53      * @since Descripter 1.0
54      */
55     public final Function<?> caller() {
56         return (Function<?>)get(core()._caller);
57     }
58 
59     /**
60      * <p>Gets the <tt>this</tt> member of the {@link Functor} context.</p>
61      * @return The <tt>this</tt> member of the {@link Functor} context
62      * @since Descripter 1.0
63      */
64     public final Objective<?> this_() {
65         return object(get(core()._this));
66     }
67 
68     /**
69      * <p>Executes the script context of this type.</p>
70      * <p>This method executes this {@link Functor}</p>
71      * @since Descripter 1.0
72      */
73     @Override
74     public final void run() {
75         function();
76     }
77 
78     /**
79      * <p>An abstract method emulating a function definition.</p>
80      * <p>Subclasses need to concretely implement this method.</p>
81      * @return The return result of the invocation of this {@link Functor}
82      * @since Descripter 1.0
83      */
84     public abstract Object function();
85 }