/interpreter/tags/at2dist091109/src/edu/vub/at/objects/grammar/ATDefMethod.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATDefMethod.java created on 26-jul-2006 at 14:50:35
 4 * (c) Programming Technology Lab, 2006 - 2007
 5 * Authors: Tom Van Cutsem & Stijn Mostinckx
 6 * 
 7 * Permission is hereby granted, free of charge, to any person
 8 * obtaining a copy of this software and associated documentation
 9 * files (the "Software"), to deal in the Software without
10 * restriction, including without limitation the rights to use,
11 * copy, modify, merge, publish, distribute, sublicense, and/or
12 * sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following
14 * conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
21 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
23 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
24 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 * OTHER DEALINGS IN THE SOFTWARE.
27 */
28package edu.vub.at.objects.grammar;
29
30import edu.vub.at.objects.ATTable;
31
32/**
33 * The public interface to a method definition AG element.
34 * 
35 * Example: <code>def m(a, b) { a + b }</code>
36 * 
37 * @author tvcutsem
38 */
39public interface ATDefMethod extends ATDefinition {
40
41	/**
42	 * The selector must be a literal symbol.
43	 * Example: <code>`{ def m() { 5 } }.statements[1].selector == `m</code>
44	 * @return the selector of the method
45	 */
46	public ATSymbol base_selector();
47	
48	/**
49	 * A method may have zero, one or more formal arguments.
50	 * Slicing is allowed in the argument list.
51	 * Example: <code>`{ def m(a, @b) { b } }.statements[1].arguments == `[a, @b]</code>
52	 * @return the formal argument list
53	 */
54	public ATTable base_arguments();
55	
56	/**
57	 * The body of a method may not be empty.
58	 * Example: <code>`{ def m(a, b) { a.n(); b+1 } }.statements[1].bodyExpression == `{ a.n(); b.+(1) }</code>
59	 * @return The body of the method
60	 */
61	public ATBegin base_bodyExpression();
62	
63	/**
64	 * A method may have zero or more annotations.
65	 * Example; <code>`{def m() @[Getter] { x }}.statements[1].annotations == `[Getter]</code>
66	 * @return The annotations of the method
67	 */
68	public ATExpression base_annotationExpression();
69}