public abstract Class ResourceFinder

Class Inheritance

extends Object

Known Direct Subclasses

Imports

Finds a resource by name.

Notice that there is a symmetrical concept org.codehaus.commons.compiler.util.resource.ResourceCreator that creates resources for writing.

See Also: findResource(String), findResourceAsStream(String), org.codehaus.commons.compiler.util.resource.ResourceCreator

Field Summary

Modifier and Type	Field and Description
public static final ListableResourceFinder	EMPTY_RESOURCE_FINDER This one's useful when a resource finder is required, but cannot be created for some reason.

Access	Constructor and Description
public	ResourceFinder()

Modifier and Type	Method and Description
public abstract Resource	Returns: `null` if the resource could not be found findResource(String Designates the resource; typically structured by slashes ("/") like "`com/foo/pkg/Bar.class`" resourceName) Finds a resource by name and return it as a `Resource` object.
public final InputStream	Returns: `null` if the resource could not be found findResourceAsStream(String Designates the resource; typically structured by slashes ("/") like "`com/foo/pkg/Bar.class`" resourceName) Finds a resource by name and open it for reading.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

EMPTY_RESOURCE_FINDER	back to summary
public static final ListableResourceFinder EMPTY_RESOURCE_FINDER This one's useful when a resource finder is required, but cannot be created for some reason.

ResourceFinder	back to summary
public ResourceFinder()

findResource back to summary

findResource	back to summary
public abstract Resource findResource(String resourceName) Finds a resource by name and return it as a `Resource` object. Parameters resourceName:String Designates the resource; typically structured by slashes ("/") like "`com/foo/pkg/Bar.class`" Returns:Resource `null` if the resource could not be found Annotations @Nullable

public abstract Resource findResource(String resourceName)

Finds a resource by name and return it as a Resource object.

Parameters

resourceName:String: Designates the resource; typically structured by slashes ("/") like "com/foo/pkg/Bar.class"

null if the resource could not be found

Annotations

findResourceAsStream back to summary

findResourceAsStream	back to summary
public final InputStream findResourceAsStream(String resourceName) throws IOException Finds a resource by name and open it for reading. Parameters resourceName:String Designates the resource; typically structured by slashes ("/") like "`com/foo/pkg/Bar.class`" Returns:InputStream `null` if the resource could not be found Annotations @Nullable Exceptions IOException: The resource was found, but there are problems opening it

public final InputStream findResourceAsStream(String resourceName) throws IOException

Finds a resource by name and open it for reading.

Parameters

resourceName:String: Designates the resource; typically structured by slashes ("/") like "com/foo/pkg/Bar.class"

null if the resource could not be found

Annotations

Exceptions