Open Source Repository

Home /ibatis/ibatis-sqlmap-3.0-beta8 | Repository Home


org/apache/ibatis/io/Resources.java
package org.apache.ibatis.io;

import java.io.*;
import java.net.URL;
import java.net.URLConnection;
import java.nio.charset.Charset;
import java.util.Properties;

/**
 * A class to simplify access to resources through the classloader.
 */
public class Resources {

  private static ClassLoaderWrapper classLoaderWrapper = new ClassLoaderWrapper();

  /**
   * Charset to use when calling getResourceAsReader.
   * null means use the system default.
   */
  private static Charset charset;

  Resources() {
  }

  /**
   * Returns the default classloader (may be null).
   *
   @return The default classloader
   */
  public static ClassLoader getDefaultClassLoader() {
    return classLoaderWrapper.defaultClassLoader;
  }

  /**
   * Sets the default classloader
   *
   @param defaultClassLoader - the new default ClassLoader
   */
  public static void setDefaultClassLoader(ClassLoader defaultClassLoader) {
    classLoaderWrapper.defaultClassLoader = defaultClassLoader;
  }

  /**
   * Returns the URL of the resource on the classpath
   *
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static URL getResourceURL(String resourcethrows IOException {
    return classLoaderWrapper.getResourceAsURL(resource);
  }

  /**
   * Returns the URL of the resource on the classpath
   *
   @param loader   The classloader used to fetch the resource
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static URL getResourceURL(ClassLoader loader, String resourcethrows IOException {
    URL url = classLoaderWrapper.getResourceAsURL(resource, loader);
    if (url == nullthrow new IOException("Could not find resource " + resource);
    return url;
  }

  /**
   * Returns a resource on the classpath as a Stream object
   *
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static InputStream getResourceAsStream(String resourcethrows IOException {
    return getResourceAsStream(null, resource);
  }

  /**
   * Returns a resource on the classpath as a Stream object
   *
   @param loader   The classloader used to fetch the resource
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static InputStream getResourceAsStream(ClassLoader loader, String resourcethrows IOException {
    InputStream in = classLoaderWrapper.getResourceAsStream(resource, loader);
    if (in == nullthrow new IOException("Could not find resource " + resource);
    return in;
  }

  /**
   * Returns a resource on the classpath as a Properties object
   *
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static Properties getResourceAsProperties(String resourcethrows IOException {
    Properties props = new Properties();
    InputStream in = getResourceAsStream(resource);
    props.load(in);
    in.close();
    return props;
  }

  /**
   * Returns a resource on the classpath as a Properties object
   *
   @param loader   The classloader used to fetch the resource
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static Properties getResourceAsProperties(ClassLoader loader, String resourcethrows IOException {
    Properties props = new Properties();
    InputStream in = getResourceAsStream(loader, resource);
    props.load(in);
    in.close();
    return props;
  }

  /**
   * Returns a resource on the classpath as a Reader object
   *
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static Reader getResourceAsReader(String resourcethrows IOException {
    Reader reader;
    if (charset == null) {
      reader = new InputStreamReader(getResourceAsStream(resource));
    else {
      reader = new InputStreamReader(getResourceAsStream(resource), charset);
    }
    return reader;
  }

  /**
   * Returns a resource on the classpath as a Reader object
   *
   @param loader   The classloader used to fetch the resource
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static Reader getResourceAsReader(ClassLoader loader, String resourcethrows IOException {
    Reader reader;
    if (charset == null) {
      reader = new InputStreamReader(getResourceAsStream(loader, resource));
    else {
      reader = new InputStreamReader(getResourceAsStream(loader, resource), charset);
    }
    return reader;
  }

  /**
   * Returns a resource on the classpath as a File object
   *
   @param resource The resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static File getResourceAsFile(String resourcethrows IOException {
    return new File(getResourceURL(resource).getFile());
  }

  /**
   * Returns a resource on the classpath as a File object
   *
   @param loader   - the classloader used to fetch the resource
   @param resource - the resource to find
   @return The resource
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static File getResourceAsFile(ClassLoader loader, String resourcethrows IOException {
    return new File(getResourceURL(loader, resource).getFile());
  }

  /**
   * Gets a URL as an input stream
   *
   @param urlString - the URL to get
   @return An input stream with the data from the URL
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static InputStream getUrlAsStream(String urlStringthrows IOException {
    URL url = new URL(urlString);
    URLConnection conn = url.openConnection();
    return conn.getInputStream();
  }

  /**
   * Gets a URL as a Reader
   *
   @param urlString - the URL to get
   @return A Reader with the data from the URL
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static Reader getUrlAsReader(String urlStringthrows IOException {
    return new InputStreamReader(getUrlAsStream(urlString));
  }

  /**
   * Gets a URL as a Properties object
   *
   @param urlString - the URL to get
   @return A Properties object with the data from the URL
   @throws java.io.IOException If the resource cannot be found or read
   */
  public static Properties getUrlAsProperties(String urlStringthrows IOException {
    Properties props = new Properties();
    InputStream in = getUrlAsStream(urlString);
    props.load(in);
    in.close();
    return props;
  }

  /**
   * Loads a class
   *
   @param className - the class to fetch
   @return The loaded class
   @throws ClassNotFoundException If the class cannot be found (duh!)
   */
  public static Class classForName(String classNamethrows ClassNotFoundException {
    return classLoaderWrapper.classForName(className);
  }

  public static Charset getCharset() {
    return charset;
  }

  public static void setCharset(Charset charset) {
    Resources.charset = charset;
  }

}