ResourceResolverAware.java
01 /*
02  * Copyright 2008-2014 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.transform;
17 
18 import java.lang.annotation.*;
19 
20 /**
21  <p>Annotates a class.</p>
22  <p/>
23  <p>When annotating a class it indicates that it will be able to resolve
24  * messages using Griffon's {@code ResourceResolver} mechanism.</p>
25  <p/>
26  * The following methods will be added to classes annotated with &#064;ResourceResolverAware
27  <ul>
28  <li><code>public Object resolveResourceValue(java.lang.String, java.util.Locale)</code></li>
29  <li><code>public Object resolveResource(java.lang.String)</code></li>
30  <li><code>public Object resolveResource(java.lang.String, java.util.Locale)</code></li>
31  <li><code>public Object resolveResource(java.lang.String, java.lang.Object[])</code></li>
32  <li><code>public Object resolveResource(java.lang.String, java.lang.Object[], java.util.Locale)</code></li>
33  <li><code>public Object resolveResource(java.lang.String, java.util.List)</code></li>
34  <li><code>public Object resolveResource(java.lang.String, java.util.List, java.util.Locale)</code></li>
35  <li><code>public Object resolveResource(java.lang.String, java.util.Map)</code></li>
36  <li><code>public Object resolveResource(java.lang.String, java.util.Map, java.util.Locale)</code></li>
37  <li><code>public Object resolveResource(java.lang.String, java.lang.Object)</code></li>
38  <li><code>public Object resolveResource(java.lang.String, java.lang.Object, java.util.Locale)</code></li>
39  <li><code>public Object resolveResource(java.lang.String, java.lang.Object[], java.lang.Object)</code></li>
40  <li><code>public Object resolveResource(java.lang.String, java.lang.Object[], java.lang.Object, java.util.Locale)</code></li>
41  <li><code>public Object resolveResource(java.lang.String, java.util.List, java.lang.Object)</code></li>
42  <li><code>public Object resolveResource(java.lang.String, java.util.List, java.lang.Object, java.util.Locale)</code></li>
43  <li><code>public Object resolveResource(java.lang.String, java.util.Map, java.lang.Object)</code></li>
44  <li><code>public Object resolveResource(java.lang.String, java.util.Map, java.lang.Object, java.util.Locale)</code></li>
45  <li><code>public String formatResource(java.lang.String, java.lang.Object[])</code></li>
46  <li><code>public String formatResource(java.lang.String, java.util.List)</code></li>
47  <li><code>public String formatResource(java.lang.String, java.util.Map)</code></li>
48  <p/>
49  </ul>
50  *
51  @author Andres Almiray
52  @see griffon.core.resources.ResourceResolver
53  */
54 @Documented
55 @Retention(RetentionPolicy.SOURCE)
56 @Target(ElementType.TYPE)
57 public @interface ResourceResolverAware {
58     String value() default "";
59 }