ResourceResolverAware.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 resolve
30  * messages using Griffon's {@code ResourceResolver} mechanism.</p>
31  <p/>
32  * The following methods will be added to classes annotated with &#064;ResourceResolverAware
33  <ul>
34  <li><code>public Object resolveResourceValue(java.lang.String, java.util.Locale)</code></li>
35  <li><code>public Object resolveResource(java.lang.String)</code></li>
36  <li><code>public Object resolveResource(java.lang.String, 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.util.List)</code></li>
40  <li><code>public Object resolveResource(java.lang.String, java.util.List, java.util.Locale)</code></li>
41  <li><code>public Object resolveResource(java.lang.String, java.util.Map)</code></li>
42  <li><code>public Object resolveResource(java.lang.String, java.util.Map, java.util.Locale)</code></li>
43  <li><code>public Object resolveResource(java.lang.String, java.lang.Object)</code></li>
44  <li><code>public Object resolveResource(java.lang.String, java.lang.Object, java.util.Locale)</code></li>
45  <li><code>public Object resolveResource(java.lang.String, java.lang.Object[], java.lang.Object)</code></li>
46  <li><code>public Object resolveResource(java.lang.String, java.lang.Object[], java.lang.Object, java.util.Locale)</code></li>
47  <li><code>public Object resolveResource(java.lang.String, java.util.List, java.lang.Object)</code></li>
48  <li><code>public Object resolveResource(java.lang.String, java.util.List, java.lang.Object, java.util.Locale)</code></li>
49  <li><code>public Object resolveResource(java.lang.String, java.util.Map, java.lang.Object)</code></li>
50  <li><code>public Object resolveResource(java.lang.String, java.util.Map, java.lang.Object, java.util.Locale)</code></li>
51  <li><code>public String formatResource(java.lang.String, java.lang.Object[])</code></li>
52  <li><code>public String formatResource(java.lang.String, java.util.List)</code></li>
53  <li><code>public String formatResource(java.lang.String, java.util.Map)</code></li>
54  <p/>
55  </ul>
56  *
57  @author Andres Almiray
58  @see griffon.core.resources.ResourceResolver
59  */
60 @Documented
61 @Retention(RetentionPolicy.SOURCE)
62 @Target(ElementType.TYPE)
63 public @interface ResourceResolverAware {
64     String value() default "";
65 }