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