01 /*
02 * Copyright 2010-2012 the original author or authors.
03 *
04 * Licensed under the Apache License, Version 2.0 (the "License");
05 * you may not use this file except in compliance with the License.
06 * You may obtain a copy of the License at
07 *
08 * http://www.apache.org/licenses/LICENSE-2.0
09 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package griffon.core;
17
18 /**
19 * Represents a Controller class in Griffon.<p>
20 *
21 * @author Andres Almiray
22 * @since 0.9.1
23 */
24 public interface GriffonControllerClass extends GriffonClass {
25 /**
26 * "controller"
27 */
28 String TYPE = "controller";
29 /**
30 * "Controller"
31 */
32 String TRAILING = "Controller";
33
34 /**
35 * Matches all public methods and all properties that
36 * have a Closure as value.<p>
37 * Actions are subject to the following rules in order to be considered as such:<ul>
38 * <li>must have public (Java) or default (Groovy) visibility modifier. </li>
39 * <li>name does not match an event handler, i.e, it does not begin with <tt>on</tt>.</li>
40 * <li>must pass {code GriffonClassUtils.isPlainMethod()} if it's a method.</li>
41 * <li>must have <tt>void</tt> as return type if it's a method.</li>
42 * <li>value must be a closure (including curried method pointers) if it's a property.</li>
43 * </ul>
44 *
45 * @return an array containing the names of all action names.
46 */
47 String[] getActionNames();
48
49 /**
50 * Matches all public methods and closure properties whose name
51 * matches the event handler convention, i.e, starts with "on" and
52 * is followed by at least one uppercase character.<p>
53 *
54 * @return an array containing the names of all event handlers.
55 */
56 String[] getEventNames();
57 }
|