Package com.ibatis.common.resources
Class Resources
java.lang.Object
com.ibatis.common.resources.Resources
A class to simplify access to resources through the classloader.
-
Method Summary
Modifier and TypeMethodDescriptionstatic ClassclassForName(String className) Loads a class.static CharsetGets the charset.static ClassLoaderReturns the default classloader (may be null).static FilegetResourceAsFile(ClassLoader loader, String resource) Returns a resource on the classpath as a File object.static FilegetResourceAsFile(String resource) Returns a resource on the classpath as a File object.static PropertiesgetResourceAsProperties(ClassLoader loader, String resource) Returns a resource on the classpath as a Properties object.static PropertiesgetResourceAsProperties(String resource) Returns a resource on the classpath as a Properties object.static ReadergetResourceAsReader(ClassLoader loader, String resource) Returns a resource on the classpath as a Reader object.static ReadergetResourceAsReader(String resource) Returns a resource on the classpath as a Reader object.static InputStreamgetResourceAsStream(ClassLoader loader, String resource) Returns a resource on the classpath as a Stream object.static InputStreamgetResourceAsStream(String resource) Returns a resource on the classpath as a Stream object.static URLgetResourceURL(ClassLoader loader, String resource) Returns the URL of the resource on the classpath.static URLgetResourceURL(String resource) Returns the URL of the resource on the classpath.static PropertiesgetUrlAsProperties(String urlString) Gets a URL as a Properties object.static ReadergetUrlAsReader(String urlString) Gets a URL as a Reader.static InputStreamgetUrlAsStream(String urlString) Gets a URL as an input stream.static Objectinstantiate(Class clazz) Creates an instance of a class.static Objectinstantiate(String className) Creates an instance of a class.static voidsetCharset(Charset charset) Use this method to set the Charset to be used when calling the getResourceAsReader methods.static voidsetDefaultClassLoader(ClassLoader defaultClassLoader) Sets the default classloader.
-
Method Details
-
getDefaultClassLoader
Returns the default classloader (may be null).- Returns:
- The default classloader
-
setDefaultClassLoader
Sets the default classloader.- Parameters:
defaultClassLoader- - the new default ClassLoader
-
getResourceURL
Returns the URL of the resource on the classpath.- Parameters:
resource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceURL
Returns the URL of the resource on the classpath.- Parameters:
loader- The classloader used to load the resourceresource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsStream
Returns a resource on the classpath as a Stream object.- Parameters:
resource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsStream
public static InputStream getResourceAsStream(ClassLoader loader, String resource) throws IOException Returns a resource on the classpath as a Stream object.- Parameters:
loader- The classloader used to load the resourceresource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsProperties
Returns a resource on the classpath as a Properties object.- Parameters:
resource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsProperties
public static Properties getResourceAsProperties(ClassLoader loader, String resource) throws IOException Returns a resource on the classpath as a Properties object.- Parameters:
loader- The classloader used to load the resourceresource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsReader
Returns a resource on the classpath as a Reader object.- Parameters:
resource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsReader
Returns a resource on the classpath as a Reader object.- Parameters:
loader- The classloader used to load the resourceresource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsFile
Returns a resource on the classpath as a File object.- Parameters:
resource- The resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getResourceAsFile
Returns a resource on the classpath as a File object.- Parameters:
loader- - the classloader used to load the resourceresource- - the resource to find- Returns:
- The resource
- Throws:
IOException- If the resource cannot be found or read
-
getUrlAsStream
Gets a URL as an input stream.- Parameters:
urlString- - the URL to get- Returns:
- An input stream with the data from the URL
- Throws:
IOException- If the resource cannot be found or read
-
getUrlAsReader
Gets a URL as a Reader.- Parameters:
urlString- - the URL to get- Returns:
- A Reader with the data from the URL
- Throws:
IOException- If the resource cannot be found or read
-
getUrlAsProperties
Gets a URL as a Properties object.- Parameters:
urlString- - the URL to get- Returns:
- A Properties object with the data from the URL
- Throws:
IOException- If the resource cannot be found or read
-
classForName
Loads a class.- Parameters:
className- - the class to load- Returns:
- The loaded class
- Throws:
ClassNotFoundException- If the class cannot be found (duh!)
-
instantiate
public static Object instantiate(String className) throws ClassNotFoundException, InstantiationException, IllegalAccessException Creates an instance of a class.- Parameters:
className- - the class to create- Returns:
- An instance of the class
- Throws:
ClassNotFoundException- If the class cannot be found (duh!)InstantiationException- If the class cannot be instantiaedIllegalAccessException- If the class is not public, or other access problems arise
-
instantiate
Creates an instance of a class.- Parameters:
clazz- - the class to create- Returns:
- An instance of the class
- Throws:
InstantiationException- If the class cannot be instantiaedIllegalAccessException- If the class is not public, or other access problems arise
-
getCharset
Gets the charset.- Returns:
- the charset
-
setCharset
Use this method to set the Charset to be used when calling the getResourceAsReader methods. This will allow iBATIS to function properly when the system default encoding doesn't deal well with unicode (IBATIS-340, IBATIS-349)- Parameters:
charset- the new charset
-