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