ResourceLoader (MRules Javadoc 2.7.0 API)

java.lang.Object
- com.massa.util.classloader.ResourceLoader

```
public final class ResourceLoader
extends Object
```
A static API that can be used as a drop-in replacement for java.lang.ClassLoader API (the class/resource loading part). This implementation is merely a wrapper around ClassLoaderResolver.getClassLoader() method, which also adds features like searching in the classpath.

Author:

(C) Vlad Roubtsov, 2003

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Set<String>`	`getAllJarResourceNames(String pathToUse, Pattern p, boolean searchSubDirectories, String jarPath)` Given a Jar, parses all entries to retrieve those which correspond to provided criteria.
`static Set<String>`	`getAllJarResourceNames(String pathToUse, Pattern p, boolean searchSubDirectories, URL jarUrl)` Given a Jar from the classpath, parses all entries to retrieve those which correspond to provided criteria.
`static Set<String>`	`getAllJarResourceNames(String pathToUse, String regex, boolean searchSubDirectories, String jarPath)` Given a Jar, parses all entries to retrieve those which correspond to provided criteria.
`static Set<String>`	`getAllJarResourceNames(String pathToUse, String regex, boolean searchSubDirectories, URL jarUrl)` Given a Jar from the classpath, parses all entries to retrieve those which correspond to provided criteria.
`static Set<Resource>`	`getAllJarResources(String pathToUse, Pattern p, boolean searchSubDirectories, String jarPath)` Given a Jar from the classpath, parses all entries to retrieve those which correspond to provided criteria.
`static Set<Resource>`	`getAllJarResources(String pathToUse, Pattern p, boolean searchSubDirectories, URL jarUrl)` Given a Jar from the classpath, parses all entries to retrieve those which correspond to provided criteria.
`static Set<Resource>`	`getAllJarResources(String pathToUse, String regex, boolean searchSubDirectories, String jarPath)` Given a Jar from the classpath, parses all entries to retrieve those which correspond to provided criteria.
`static Set<Resource>`	`getAllJarResources(String pathToUse, String regex, boolean searchSubDirectories, URL jarUrl)` Given a Jar from the classpath, parses all entries to retrieve those which correspond to provided criteria.
`static Collection<String>`	`getAllJrtResourceNames(String regex, boolean searchSubDirectories, String firstJrtElement, String... moreJrtElements)` Given JRT elements, parses all entries to retrieve those which correspond to provided criteria.
`static ClassLoader`	`getClassLoader()` Retrieves ClassLoader for caller
`static Collection<URI>`	`getClassPath()`
`static Collection<String>`	`getMatchingResourceNames(String packageName, String regex)` Returns only resource names without URL.
`static Collection<String>`	`getMatchingResourceNames(String packageName, String regex, boolean searchSubDirectories)` Returns only resource names without URL.
`static Collection<String>`	`getMatchingResourceNames(String packageName, String regex, boolean searchSubDirectories, ClassLoader loader)` Returns only resource names without URL.
`static Collection<String>`	`getMatchingResourceNames(String packageName, String regex, ClassLoader loader)` Returns only resource names without URL.
`static Collection<Resource>`	`getMatchingResources(String packageName, String regex)` Parses all classpath resources to locate ones in the provided path which names match the provided regex.
`static Collection<Resource>`	`getMatchingResources(String packageName, String regex, boolean searchSubDirectories)` Parses all classpath resources to locate ones in the provided path which names match the provided regex.
`static Collection<Resource>`	`getMatchingResources(String packageName, String regex, boolean searchSubDirectories, ClassLoader loader)` Parses all classpath resources to locate ones in the provided path which names match the provided regex.
`static Collection<Resource>`	`getMatchingResources(String packageName, String regex, ClassLoader loader)` Parses all classpath resources to locate ones in the provided path which names match the provided regex.
`static URL`	`getResource(String name)`
`static InputStream`	`getResourceAsStream(String name)`
`static Enumeration<URL>`	`getResources(String name)`
`static Class<?>`	`loadClass(String name)`
`static Class<?>`	`loadClass(String name, boolean initialize)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClassLoader

public static ClassLoader getClassLoader()

Retrieves ClassLoader for caller

getClassPath

public static Collection<URI> getClassPath()
                                    throws IOException

Returns:: Collection of URL of classpath elements.
Throws:: IOException

loadClass

public static Class<?> loadClass(String name)
                          throws ClassNotFoundException

Throws:: ClassNotFoundException
See Also:: ClassLoader.loadClass(java.lang.String)

loadClass

public static Class<?> loadClass(String name,
                                 boolean initialize)
                          throws ClassNotFoundException

Throws:: ClassNotFoundException
See Also:: ClassLoader.loadClass(java.lang.String)

getResource
```
public static URL getResource(String name)
```
See Also:

ClassLoader.getResource(java.lang.String)

getResourceAsStream
```
public static InputStream getResourceAsStream(String name)
```
See Also:

ClassLoader.getResourceAsStream(java.lang.String)

getResources

public static Enumeration<URL> getResources(String name)
                                     throws IOException

Throws:: IOException
See Also:: ClassLoader.getResources(java.lang.String)

getMatchingResources
```
public static Collection<Resource> getMatchingResources(String packageName,
                                                        String regex)
                                                 throws IOException
```
Parses all classpath resources to locate ones in the provided path which names match the provided regex. Subdirectories are not searched.
The packageName separator character must be a '.' or a '/'.
Providing a path may increase performances drastically.

Throws:

IOException

getMatchingResourceNames

public static Collection<String> getMatchingResourceNames(String packageName,
                                                          String regex)
                                                   throws IOException

Returns only resource names without URL. As a consequence, if several resources have the same name but in different elements of the classpath, only one entry in the returned set will appear.

Throws:: IOException
See Also:: getMatchingResources(String, String)

getMatchingResources

public static Collection<Resource> getMatchingResources(String packageName,
                                                        String regex,
                                                        boolean searchSubDirectories)
                                                 throws IOException

Parses all classpath resources to locate ones in the provided path which names match the provided regex. Subdirectories are not searched.
The packageName separator character must be a '.' or a '/'.
Providing a path may increase performances drastically.

Throws:: IOException

getMatchingResourceNames

public static Collection<String> getMatchingResourceNames(String packageName,
                                                          String regex,
                                                          boolean searchSubDirectories)
                                                   throws IOException

Returns only resource names without URL. As a consequence, if several resources have the same name but in different elements of the classpath, only one entry in the returned set will appear.

Throws:: IOException
See Also:: getMatchingResources(String, String, boolean)

getMatchingResources

public static Collection<Resource> getMatchingResources(String packageName,
                                                        String regex,
                                                        ClassLoader loader)
                                                 throws IOException

Throws:: IOException

getMatchingResourceNames

public static Collection<String> getMatchingResourceNames(String packageName,
                                                          String regex,
                                                          ClassLoader loader)
                                                   throws IOException

Returns only resource names without URL. As a consequence, if several resources have the same name but in different elements of the classpath, only one entry in the returned set will appear.

Throws:: IOException
See Also:: getMatchingResources(String, String, ClassLoader)

getMatchingResources

public static Collection<Resource> getMatchingResources(String packageName,
                                                        String regex,
                                                        boolean searchSubDirectories,
                                                        ClassLoader loader)
                                                 throws IOException

Parses all classpath resources to locate ones in the provided path which names match the provided regex.
The packageName separator character must be a '.' or a '/'.
Providing a path may increase performances drastically.

Throws:: IOException

getMatchingResourceNames

public static Collection<String> getMatchingResourceNames(String packageName,
                                                          String regex,
                                                          boolean searchSubDirectories,
                                                          ClassLoader loader)
                                                   throws IOException

Returns only resource names without URL. As a consequence, if several resources have the same name but in different elements of the classpath, only one entry in the returned set will appear.

Throws:: IOException
See Also:: getMatchingResources(String, String, boolean, ClassLoader)

getAllJarResourceNames

public static Set<String> getAllJarResourceNames(String pathToUse,
                                                 String regex,
                                                 boolean searchSubDirectories,
                                                 String jarPath)
                                          throws IOException

Given a Jar, parses all entries to retrieve those which correspond to provided criteria.

Throws:: IOException

getAllJarResourceNames

public static Set<String> getAllJarResourceNames(String pathToUse,
                                                 Pattern p,
                                                 boolean searchSubDirectories,
                                                 String jarPath)
                                          throws IOException

Given a Jar, parses all entries to retrieve those which correspond to provided criteria.

Throws:: IOException