org.anc.resource.ResourceLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common Show documentation

Common utility classes used in most ANC projects.

The newest version!

package org.anc.resource;

import org.anc.io.UTF8Reader;

import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URL;

/**
 * A class that provides utility methods for loading resources from
 * the classpath.
 *
 * @author Keith Suderman
 */
public class ResourceLoader
{
   private ResourceLoader()
   {

   }

   /**
    * Returns an InputStream for reading the specified resource.
    *
    * @param name the name of the resource to be opened.
    * @return an opened InputStream that can be used to read the resource,
    * or null if no such resource exists.
    */
   public static InputStream open(String name)
   {
      return getClassLoader().getResourceAsStream(name);
   }

   /**
    * Reads a UTF-8 string from the specified resource.
    *
    * @param name the name of the resource to be read.
    * @return a UTF-8 string containing the contents of the resource.
    * @throws IOException if the resource can not be found
    */
   public static String loadString(String name) throws IOException
   {
      InputStream stream = open(name);
      if (stream == null)
      {
         throw new IOException("Resource not found: " + name);
      }
      UTF8Reader reader = new UTF8Reader(stream);;
      String result = null;
      try
      {
         result = reader.readString();
      }
      finally
      {
         reader.close();
      }
      return result;
   }

   public static ClassLoader getClassLoader()
   {
      ClassLoader loader = Thread.currentThread().getContextClassLoader();
      if (loader == null)
      {
         loader = ResourceLoader.class.getClassLoader();
      }
      return loader;
   }

   public static URL getResource(String name) {
      ClassLoader loader = getClassLoader();
      return loader.getResource(name);
   }
}