cvs commit: jakarta-turbine-maven/src/java/org/apache/maven/util ResourceBean.java

[js...@apache.org]

jstrachan    2002/12/11 08:44:34

  Added:       src/java/org/apache/maven/util ResourceBean.java
  Log:
  Added a helper bean that can be used as a tool from inside plugins to load resources from a custom ClassLoader or from the jar that the plugin is contained in.
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-maven/src/java/org/apache/maven/util/ResourceBean.java
  
  Index: ResourceBean.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Velocity", "DVSL" and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  package org.apache.maven.util;
  
  import java.net.URL;
  
  /**
   * A helper bean to load the given URI from the current threads class loader or
   * the class loader that was used to load this class.
   * 
   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
   */
  
  public class ResourceBean
  {
      private ClassLoader classLoader;
  
      /**
       * Attempts to load the given resource from the given name.
       * The current thrad context class loader will be tried first, then the
       * class loader used to load this class.
       * 
       * If the classLoader property on this bean is set then that ClassLoader is
       * used in preference to any other.
       * 
       * @param name of the resource to load
       * @return URL of the resource or null if could not be found
       */
      public URL findResource(String name) 
      {
          URL answer = null;
          if (classLoader != null)
          {
              answer = classLoader.getResource(name);
          }
          // lets try the current threads class loader first
          if (answer == null)
          {
              ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
              if (contextClassLoader != null)
              { 
                  answer = contextClassLoader.getResource(name);
              }
              if (answer == null)
              {
                  answer = getClass().getClassLoader().getResource(name);
              }
          }
          return answer;
      }
      
      /**
       * Returns the classLoader.
       * @return ClassLoader
       */
      public ClassLoader getClassLoader() {
          return classLoader;
      }
  
      /**
       * Sets the classLoader.
       * @param classLoader The classLoader to set
       */
      public void setClassLoader(ClassLoader classLoader) {
          this.classLoader = classLoader;
      }
  
  }