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