GriffonModelClass.java
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 import javax.annotation.Nullable;
22 
23 /**
24  * Represents a Model class in Griffon.<p>
25  *
26  @author Andres Almiray
27  @since 2.0.0
28  */
29 public interface GriffonModelClass extends GriffonClass {
30     /**
31      * "model"
32      */
33     String TYPE = "model";
34     /**
35      * "Model"
36      */
37     String TRAILING = "Model";
38 
39     /**
40      * Matches all public properties that are not event handlers nor
41      * have a Closure as their value.<p>
42      *
43      @return an array containing the names of all model properties.
44      */
45     @Nonnull
46     String[] getPropertyNames();
47 
48     /**
49      * Matches all public methods and closure properties whose name
50      * matches the event handler convention, i.e, starts with "on" and
51      * is followed by at least one uppercase character.<p>
52      *
53      @return an array containing the names of all event handlers.
54      */
55     @Nonnull
56     String[] getEventNames();
57 
58     /**
59      * Sets a value of a model property.
60      *
61      @param model        the model to be affected
62      @param propertyName the name of the property to update
63      @param value        new value
64      */
65     void setModelPropertyValue(@Nonnull GriffonModel model, @Nonnull String propertyName, @Nullable Object value);
66 
67     /**
68      * Returns the value of a model property.
69      *
70      @param model        the model to query
71      @param propertyName the name of the property to query
72      @return the value of the property
73      */
74     @Nullable
75     Object getModelPropertyValue(@Nonnull GriffonModel model, @Nonnull String propertyName);
76 }