Package org.apache.ibatis.io

Class Resources

  • public class Resources
extends java.lang.Object
    A class to simplify access to resources through the classloader.
    Author:
    Clinton Begin

    • Method Summary

      Modifier and Type Method Description
      static java.lang.Class<?> classForName​(java.lang.String className)
      Loads a class
      static java.nio.charset.Charset getCharset()  
      static java.lang.ClassLoader getDefaultClassLoader()
      Returns the default classloader (may be null).
      static java.io.File getResourceAsFile​(java.lang.ClassLoader loader, java.lang.String resource)
      Returns a resource on the classpath as a File object
      static java.io.File getResourceAsFile​(java.lang.String resource)
      Returns a resource on the classpath as a File object
      static java.util.Properties getResourceAsProperties​(java.lang.ClassLoader loader, java.lang.String resource)
      Returns a resource on the classpath as a Properties object
      static java.util.Properties getResourceAsProperties​(java.lang.String resource)
      Returns a resource on the classpath as a Properties object
      static java.io.Reader getResourceAsReader​(java.lang.ClassLoader loader, java.lang.String resource)
      Returns a resource on the classpath as a Reader object
      static java.io.Reader getResourceAsReader​(java.lang.String resource)
      Returns a resource on the classpath as a Reader object
      static java.io.InputStream getResourceAsStream​(java.lang.ClassLoader loader, java.lang.String resource)
      Returns a resource on the classpath as a Stream object
      static java.io.InputStream getResourceAsStream​(java.lang.String resource)
      Returns a resource on the classpath as a Stream object
      static java.net.URL getResourceURL​(java.lang.ClassLoader loader, java.lang.String resource)
      Returns the URL of the resource on the classpath
      static java.net.URL getResourceURL​(java.lang.String resource)
      Returns the URL of the resource on the classpath
      static java.util.Properties getUrlAsProperties​(java.lang.String urlString)
      Gets a URL as a Properties object
      static java.io.Reader getUrlAsReader​(java.lang.String urlString)
      Gets a URL as a Reader
      static java.io.InputStream getUrlAsStream​(java.lang.String urlString)
      Gets a URL as an input stream
      static void setCharset​(java.nio.charset.Charset charset)  
      static void setDefaultClassLoader​(java.lang.ClassLoader defaultClassLoader)
      Sets the default classloader

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getDefaultClassLoader

        public static java.lang.ClassLoader getDefaultClassLoader()
        Returns the default classloader (may be null).
        Returns:
        The default classloader

      • setDefaultClassLoader

        public static void setDefaultClassLoader​(java.lang.ClassLoader defaultClassLoader)
        Sets the default classloader
        Parameters:
        defaultClassLoader - - the new default ClassLoader

      • getResourceURL

        public static java.net.URL getResourceURL​(java.lang.String resource)
                                   throws java.io.IOException
        Returns the URL of the resource on the classpath
        Parameters:
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceURL

        public static java.net.URL getResourceURL​(java.lang.ClassLoader loader,
                                          java.lang.String resource)
                                   throws java.io.IOException
        Returns the URL of the resource on the classpath
        Parameters:
        loader - The classloader used to fetch the resource
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsStream

        public static java.io.InputStream getResourceAsStream​(java.lang.String resource)
                                               throws java.io.IOException
        Returns a resource on the classpath as a Stream object
        Parameters:
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsStream

        public static java.io.InputStream getResourceAsStream​(java.lang.ClassLoader loader,
                                                      java.lang.String resource)
                                               throws java.io.IOException
        Returns a resource on the classpath as a Stream object
        Parameters:
        loader - The classloader used to fetch the resource
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsProperties

        public static java.util.Properties getResourceAsProperties​(java.lang.String resource)
                                                    throws java.io.IOException
        Returns a resource on the classpath as a Properties object
        Parameters:
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsProperties

        public static java.util.Properties getResourceAsProperties​(java.lang.ClassLoader loader,
                                                           java.lang.String resource)
                                                    throws java.io.IOException
        Returns a resource on the classpath as a Properties object
        Parameters:
        loader - The classloader used to fetch the resource
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsReader

        public static java.io.Reader getResourceAsReader​(java.lang.String resource)
                                          throws java.io.IOException
        Returns a resource on the classpath as a Reader object
        Parameters:
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsReader

        public static java.io.Reader getResourceAsReader​(java.lang.ClassLoader loader,
                                                 java.lang.String resource)
                                          throws java.io.IOException
        Returns a resource on the classpath as a Reader object
        Parameters:
        loader - The classloader used to fetch the resource
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsFile

        public static java.io.File getResourceAsFile​(java.lang.String resource)
                                      throws java.io.IOException
        Returns a resource on the classpath as a File object
        Parameters:
        resource - The resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getResourceAsFile

        public static java.io.File getResourceAsFile​(java.lang.ClassLoader loader,
                                             java.lang.String resource)
                                      throws java.io.IOException
        Returns a resource on the classpath as a File object
        Parameters:
        loader - - the classloader used to fetch the resource
        resource - - the resource to find
        Returns:
        The resource
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getUrlAsStream

        public static java.io.InputStream getUrlAsStream​(java.lang.String urlString)
                                          throws java.io.IOException
        Gets a URL as an input stream
        Parameters:
        urlString - - the URL to get
        Returns:
        An input stream with the data from the URL
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getUrlAsReader

        public static java.io.Reader getUrlAsReader​(java.lang.String urlString)
                                     throws java.io.IOException
        Gets a URL as a Reader
        Parameters:
        urlString - - the URL to get
        Returns:
        A Reader with the data from the URL
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • getUrlAsProperties

        public static java.util.Properties getUrlAsProperties​(java.lang.String urlString)
                                               throws java.io.IOException
        Gets a URL as a Properties object
        Parameters:
        urlString - - the URL to get
        Returns:
        A Properties object with the data from the URL
        Throws:
        java.io.IOException - If the resource cannot be found or read

      • classForName

        public static java.lang.Class<?> classForName​(java.lang.String className)
                                       throws java.lang.ClassNotFoundException
        Loads a class
        Parameters:
        className - - the class to fetch
        Returns:
        The loaded class
        Throws:
        java.lang.ClassNotFoundException - If the class cannot be found (duh!)

      • getCharset

        public static java.nio.charset.Charset getCharset()

      • setCharset

        public static void setCharset​(java.nio.charset.Charset charset)