MVCAware.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.transform;
19 
20 import java.lang.annotation.Documented;
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25 
26 /**
27  <p>Annotates a class.</p>
28  <p/>
29  <p>When annotating a class it indicates that it will be able to
30  * handle MVC groups, that is, instantiate them. The class will have
31  * the ability to create new instances of MVC groups, including short-lived
32  * ones.</p>
33  <p/>
34  * The following methods will be added to classes annotated with &#064;MVCAware
35  <ul>
36  <p/>
37  <li><code>public MVCGroup createMVCGroup(String mvcType)</code></li>
38  <li><code>public MVCGroup createMVCGroup(String mvcType, String mvcId)</code></li>
39  <li><code>public MVCGroup createMVCGroup(Map&lt;String, Object&gt; args, String mvcType)</code></li>
40  <li><code>public MVCGroup createMVCGroup(String mvcType, Map&lt;String, Object&gt; args)</code></li>
41  <li><code>public MVCGroup createMVCGroup(Map&lt;String, Object&gt; args, String mvcType, String mvcId)</code></li>
42  <li><code>public MVCGroup createMVCGroup(String mvcType, String mvcId, Map&lt;String, Object&gt; args)</code></li>
43  <li><code>public &lt;MVC extends TypedMVCGroup&gt; createMVCGroup(Class&lt;? extends MVC&gt; mvcType)</code></li>
44  <li><code>public &lt;MVC extends TypedMVCGroup&gt; createMVCGroup(Class&lt;? extends MVC&gt; mvcType, String mvcId)</code></li>
45  <li><code>public &lt;MVC extends TypedMVCGroup&gt; createMVCGroup(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType)</code></li>
46  <li><code>public &lt;MVC extends TypedMVCGroup&gt; createMVCGroup(Class&lt;? extends MVC&gt; mvcType, Map&lt;String, Object&gt; args)</code></li>
47  <li><code>public &lt;MVC extends TypedMVCGroup&gt; createMVCGroup(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType, String mvcId)</code></li>
48  <li><code>public &lt;MVC extends TypedMVCGroup&gt; createMVCGroup(Class&lt;? extends MVC&gt; mvcType, String mvcId, Map&lt;String, Object&gt; args)</code></li>
49  <li><code>public List&lt;? extends GriffonMvcArtifact&gt; createMVC(String mvcType)</code></li>
50  <li><code>public List&lt;? extends GriffonMvcArtifact&gt; createMVC(Map&lt;String, Object&gt; args, String mvcType)</code></li>
51  <li><code>public List&lt;? extends GriffonMvcArtifact&gt; createMVC(String mvcType, Map&lt;String, Object&gt; args)</code></li>
52  <li><code>public List&lt;? extends GriffonMvcArtifact&gt; createMVC(String mvcType, String mvcId)</code></li>
53  <li><code>public List&lt;? extends GriffonMvcArtifact&gt; createMVC(Map&lt;String, Object&gt; args, String mvcType, String mvcId)</code></li>
54  <li><code>public List&lt;? extends GriffonMvcArtifact&gt; createMVC(String mvcType, String mvcId, Map&lt;String, Object&gt; args)</code></li>
55  <li><code>public &lt;MVC extends TypedMVCGroup&gt; List&lt;? extends GriffonMvcArtifact&gt; createMVC(Class&lt;? extends MVC&gt; mvcType)</code></li>
56  <li><code>public &lt;MVC extends TypedMVCGroup&gt; List&lt;? extends GriffonMvcArtifact&gt; createMVC(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType)</code></li>
57  <li><code>public &lt;MVC extends TypedMVCGroup&gt; List&lt;? extends GriffonMvcArtifact&gt; createMVC(Class&lt;? extends MVC&gt; mvcType, Map&lt;String, Object&gt; args)</code></li>
58  <li><code>public &lt;MVC extends TypedMVCGroup&gt; List&lt;? extends GriffonMvcArtifact&gt; createMVC(Class&lt;? extends MVC&gt; mvcType, String mvcId)</code></li>
59  <li><code>public &lt;MVC extends TypedMVCGroup&gt; List&lt;? extends GriffonMvcArtifact&gt; createMVC(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType, String mvcId)</code></li>
60  <li><code>public &lt;MVC extends TypedMVCGroup&gt; List&lt;? extends GriffonMvcArtifact&gt; createMVC(Class&lt;? extends MVC&gt; mvcType, String mvcId, Map&lt;String, Object&gt; args)</code></li>
61  <li><code>public void destroyMVCGroup(String mvcId)</code></li>
62  <li><code>public &lt;M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(String mvcType, MVCFunction&lt;M, V, C&gt; handler)</code></li>
63  <li><code>public &lt;M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(String mvcType, String mvcId, MVCFunction&lt;M, V, C&gt; handler)</code></li>
64  <li><code>public &lt;M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(String mvcType, String mvcId, Map&lt;String, Object&gt; args, MVCFunction&lt;M, V, C&gt; handler)</code></li>
65  <li><code>public &lt;M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Map&lt;String, Object&gt; args, String mvcType, String mvcId, MVCFunction&lt;M, V, C&gt; handler)</code></li>
66  <li><code>public &lt;M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(String mvcType, Map&lt;String, Object&gt; args, MVCFunction&lt;M, V, C&gt; handler)</code></li>
67  <li><code>public &lt;M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Map&lt;String, Object&gt; args, String mvcType, MVCFunction&lt;M, V, C&gt; handler)</code></li>
68  <li><code>public &lt;MVC extends TypedMVCGroup, M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Class&lt;? extends MVC&gt; mvcType, MVCFunction&lt;M, V, C&gt; handler)</code></li>
69  <li><code>public &lt;MVC extends TypedMVCGroup, M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Class&lt;? extends MVC&gt; mvcType, String mvcId, MVCFunction&lt;M, V, C&gt; handler)</code></li>
70  <li><code>public &lt;MVC extends TypedMVCGroup, M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Class&lt;? extends MVC&gt; mvcType, String mvcId, Map&lt;String, Object&gt; args, MVCFunction&lt;M, V, C&gt; handler)</code></li>
71  <li><code>public &lt;MVC extends TypedMVCGroup, M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType, String mvcId, MVCFunction&lt;M, V, C&gt; handler)</code></li>
72  <li><code>public &lt;MVC extends TypedMVCGroup, M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Class&lt;? extends MVC&gt; mvcType, Map&lt;String, Object&gt; args, MVCFunction&lt;M, V, C&gt; handler)</code></li>
73  <li><code>public &lt;MVC extends TypedMVCGroup, M extends GriffonModel, V extends GriffonView, C extends GriffonController&gt; void withMVC(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType, MVCFunction&lt;M, V, C&gt; handler)</code></li>
74  <li><code>public void withMVCGroup(String mvcType, MVCGroupFunction handler)</code></li>
75  <li><code>public void withMVCGroup(String mvcType, String mvcId, MVCGroupFunction handler)</code></li>
76  <li><code>public void withMVCGroup(String mvcType, String mvcId, Map&lt;String, Object&gt; args, MVCGroupFunction handler)</code></li>
77  <li><code>public void withMVCGroup(Map&lt;String, Object&gt; args, String mvcType, String mvcId, MVCGroupFunction handler)</code></li>
78  <li><code>public void withMVCGroup(String mvcType, Map&lt;String, Object&gt; args, MVCGroupFunction handler)</code></li>
79  <li><code>public void withMVCGroup(Map&lt;String, Object&gt; args, String mvcType, MVCGroupFunction handler)</code></li>
80  <li><code>public &lt;MVC extends TypedMVCGroup&gt; void withMVCGroup(Class&lt;? extends MVC&gt; mvcType, TypedMVCGroupFunction<MVC> handler)</code></li>
81  <li><code>public &lt;MVC extends TypedMVCGroup&gt; void withMVCGroup(Class&lt;? extends MVC&gt; mvcType, String mvcId, TypedMVCGroupFunction<MVC> handler)</code></li>
82  <li><code>public &lt;MVC extends TypedMVCGroup&gt; void withMVCGroup(Class&lt;? extends MVC&gt; mvcType, String mvcId, Map&lt;String, Object&gt; args, TypedMVCGroupFunction<MVC> handler)</code></li>
83  <li><code>public &lt;MVC extends TypedMVCGroup&gt; void withMVCGroup(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType, String mvcId, TypedMVCGroupFunction<MVC> handler)</code></li>
84  <li><code>public &lt;MVC extends TypedMVCGroup&gt; void withMVCGroup(Class&lt;? extends MVC&gt; mvcType, Map&lt;String, Object&gt; args, TypedMVCGroupFunction<MVC> handler)</code></li>
85  <li><code>public &lt;MVC extends TypedMVCGroup&gt; void withMVCGroup(Map&lt;String, Object&gt; args, Class&lt;? extends MVC&gt; mvcType, TypedMVCGroupFunction<MVC> handler)</code></li>
86  </ul>
87  *
88  @author Andres Almiray
89  @see griffon.core.mvc.MVCHandler
90  @since 2.0.0
91  */
92 @Documented
93 @Retention(RetentionPolicy.SOURCE)
94 @Target({ElementType.TYPE})
95 public @interface MVCAware {
96 }