View Javadoc

1   package org.codehaus.mojo.apt;
2   
3   /*
4    * The MIT License
5    *
6    * Copyright 2006-2008 The Codehaus.
7    *
8    * Permission is hereby granted, free of charge, to any person obtaining a copy of
9    * this software and associated documentation files (the "Software"), to deal in
10   * the Software without restriction, including without limitation the rights to
11   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12   * of the Software, and to permit persons to whom the Software is furnished to do
13   * so, subject to the following conditions:
14   *
15   * The above copyright notice and this permission notice shall be included in all
16   * copies or substantial portions of the Software.
17   *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24   * SOFTWARE.
25   */
26  
27  import java.net.URL;
28  import java.net.URLClassLoader;
29  import java.net.URLStreamHandlerFactory;
30  
31  /**
32   * Provides a more embedder friendly {@link URLClassLoader} for APT. The constructor that takes no parent will delegate
33   * to the APT class loader instead of the system class loader.
34   * 
35   * @author Benjamin Bentmann
36   */
37  public class EmbeddedURLClassLoader
38      extends URLClassLoader
39  {
40  
41      /**
42       * Fixes the class loading in APT to be embeddable. To load a factory, APT is doing something like
43       * 
44       * <pre>
45       * ClassLoader classLoader = new URLClassLoader( classPath );
46       * AnnotationProcessorFactory factory = (AnnotationProcessorFactory) classLoader.loadClass( name );
47       * </pre>
48       * 
49       * i.e. it's assumed that {@code AnnotationProcessorFactory} is present in the system class loader. This is
50       * generally wrong so we derive the factory class loader from the APT class loader.
51       */
52      public EmbeddedURLClassLoader( URL[] urls )
53      {
54          this( urls, AptClassLoader.INSTANCE );
55      }
56  
57      public EmbeddedURLClassLoader( URL[] urls, ClassLoader parent )
58      {
59          super( urls, parent );
60      }
61  
62      public EmbeddedURLClassLoader( URL[] urls, ClassLoader parent, URLStreamHandlerFactory factory )
63      {
64          super( urls, parent, factory );
65      }
66  
67  }