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 locate
24 * resources using Griffon's standard resource loading mechanism.</p>
25 * <p/>
26 * The following methods will be added to classes annotated with @ResourcesAware
27 * <ul>
28 * <li><code>public URL getResourceAsURL(java.lang.String)</code><br/>
29 * returns the resource URL if found</li>
30 * <li><code>public URL getResourceAsStream(java.lang.String)</code><br/>
31 * opens a stream to the resource if found</li>
32 * <li><code>public List>URL< getResources(java.lang.String)</code><br/>
33 * returns all matching resources for the specified name</li>
34 * <li><code>public ClassLoader classloader()</code><br/>
35 * returns the classloader used to locate resources</li>
36 * <p/>
37 * </ul>
38 * <p/>
39 *
40 * @author Andres Almiray
41 */
42 @Documented
43 @Retention(RetentionPolicy.SOURCE)
44 @Target(ElementType.TYPE)
45 public @interface ResourcesAware {
46 }
|