ResourcesAware.java
01 /*
02  * Copyright 2009-2012 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 
17 package griffon.transform;
18 
19 import org.codehaus.groovy.transform.GroovyASTTransformationClass;
20 
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  *
29  <p>When annotating a class it indicates that it will be able to locate
30  * resozrces using Griffon's standard resource loading mechanism.</p>
31  *
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  <p/>
41  </ul>
42  *
43  @author Andres Almiray
44  @see org.codehaus.griffon.ast.ResourcesAwareASTTransformation
45  */
46 @Retention(RetentionPolicy.SOURCE)
47 @Target(ElementType.TYPE)
48 @GroovyASTTransformationClass("org.codehaus.griffon.ast.ResourcesAwareASTTransformation")
49 public @interface ResourcesAware {
50 }