org.zkoss.util.resource
Class ClassLocator

java.lang.Object
  org.zkoss.util.resource.ClassLocator

All Implemented Interfaces:

Locator

public class ClassLocator
extends Object
implements Locator

The locator searches the current thread's context class loader, and then this class's class loader.

It is important to use this locator if you want to load something in other jar files.

Besides Locator, it also provides additional methods, such as getResources(java.lang.String).

Since this locator is used frequently, Locators.getDefault() is provided to return an instance of this class,

Author:

tomyeh

Nested Class Summary

static class

ClassLocator.Resource An item of the list returned by getDependentXMLResources(java.lang.String, java.lang.String, java.lang.String).

Constructor Summary

ClassLocator()

Method Summary

boolean	equals(Object o)
List	getDependentXMLResources(String name, String elName, String elDepends) Returns a list of resources (ClassLocator.Resource) after resolving the dependence.
String	getDirectory() Always returns null.
URL	getResource(String name) Finds the resource with the given name.
InputStream	getResourceAsStream(String name) Returns an input stream for reading the specified resource.
Enumeration	getResources(String name) Returns an enumeration of resources.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassLocator

public ClassLocator()

Method Detail

getResources

public Enumeration getResources(String name)
                         throws IOException

Returns an enumeration of resources. Unlike getDependentXMLResources(java.lang.String, java.lang.String, java.lang.String), it doesn't resolve the dependence among the resouces.

Parameters:

name - the resouce name, such as "metainfo/i3-com.xml".

Throws:

IOException

getDependentXMLResources

public List getDependentXMLResources(String name,
                                     String elName,
                                     String elDepends)
                              throws IOException

Returns a list of resources (ClassLocator.Resource) after resolving the dependence. The resource is returned in the format of ClassLocator.Resource

To resolve the dependence, it assumes each resource has two element whose name is identified by elName and elDepends. The elName element specifies the unique name of each resource. The elDepends element specifies a list of names of resources that this resource depends on. If not found, it assumes it could be loaded first.

Parameters:

name - the resouce name, such as "metainfo/i3-comp.xml".

elName - the element used to specify the name.

elDepends - the element used to specify the dependence.

Returns:

a list of ClassLocator.Resource of the specified name.

Throws:

IOException

getDirectory

public String getDirectory()

Always returns null.

Specified by:

getDirectory in interface Locator

getResource

public URL getResource(String name)

Description copied from interface: Locator

Finds the resource with the given name. A resource is some data (images, audio, text, etc) that can be accessed by class code in a way that is independent of the location of the code.

Specified by:

getResource in interface Locator

Returns:

a URL for reading the resource, or null if the resource could not be found or the caller doesn't have adequate privileges to get the resource

getResourceAsStream

public InputStream getResourceAsStream(String name)

Description copied from interface: Locator

Returns an input stream for reading the specified resource.

Specified by:

getResourceAsStream in interface Locator

Returns:

an input stream for reading the resource, or null if the resource could not be found or the caller doesn't have adequate privileges to get the resource

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object