Interface Resource

All Known Subinterfaces:

Resource

@API(status=MAINTAINED,
     since="6.0")
public interface Resource

Resource represents a resource on the classpath.

WARNING: a Resource must provide correct equals and hashCode implementations since a Resource may potentially be stored in a collection or map.

Since:

6.0

See Also:

• ResourceSupport.findAllResourcesInClasspathRoot(URI, ResourceFilter)
• ResourceSupport.findAllResourcesInPackage(String, ResourceFilter)
• ResourceSupport.findAllResourcesInModule(String, ResourceFilter)
• ResourceSupport.streamAllResourcesInClasspathRoot(URI, ResourceFilter)
• ResourceSupport.streamAllResourcesInPackage(String, ResourceFilter)
• ResourceSupport.streamAllResourcesInModule(String, ResourceFilter)

Method Summary

Modifier and Type	Method	Description
default InputStream	getInputStream()	Get an InputStream for reading this resource.
String	getName()	Get the name of this resource.
URI	getUri()	Get the URI of this resource.
static Resource	of(String name, URI uri)	Create a new Resource with the given name and URI.

Method Details

of

static Resource of(String name,
 URI uri)

Create a new Resource with the given name and URI.

Parameters:

name - the name of the resource; never null

uri - the URI of the resource; never null

Returns:

a new Resource

Since:

6.0

getName

String getName()

Get the name of this resource.

The resource name is a /-separated path. The path is relative to the classpath root in which the resource is located.

Returns:

the resource name; never null

getUri

URI getUri()

Get the URI of this resource.

Returns:

the URI of the resource; never null

getInputStream

default InputStream getInputStream()
                            throws IOException

Get an InputStream for reading this resource.

The default implementation delegates to URL.openStream() for this resource's URI.

Returns:

an input stream for this resource; never null

Throws:

IOException - if an I/O exception occurs