01 /*
02 * Copyright 2008-2015 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.artifact;
17
18 import javax.annotation.Nonnull;
19
20 /**
21 * Represents a Controller class in Griffon.<p>
22 *
23 * @author Andres Almiray
24 * @since 2.0.0
25 */
26 public interface GriffonControllerClass extends GriffonClass {
27 /**
28 * "controller"
29 */
30 String TYPE = "controller";
31 /**
32 * "Controller"
33 */
34 String TRAILING = "Controller";
35
36 /**
37 * Matches all public methods and all properties that
38 * have a Closure as value.<p>
39 * Actions are subject to the following rules in order to be considered as such:<ul>
40 * <li>must have public (Java) or default (Groovy) visibility modifier. </li>
41 * <li>name does not match an event handler, i.e, it does not begin with <tt>on</tt>.</li>
42 * <li>must pass {code GriffonClassUtils.isPlainMethod()} if it's a method.</li>
43 * <li>must have <tt>void</tt> as return type if it's a method.</li>
44 * <li>value must be a closure (including curried method pointers) if it's a property.</li>
45 * </ul>
46 *
47 * @return an array containing the names of all action names.
48 */
49 @Nonnull
50 String[] getActionNames();
51
52 /**
53 * Matches all public methods and closure properties whose name
54 * matches the event handler convention, i.e, starts with "on" and
55 * is followed by at least one uppercase character.<p>
56 *
57 * @return an array containing the names of all event handlers.
58 */
59 @Nonnull
60 String[] getEventNames();
61 }
|