Interface Resource

All Known Implementing Classes:

DefaultResource

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

Resource represents a resource on the classpath.

Since:

1.11

See Also:

• ReflectionSupport.findAllResourcesInClasspathRoot(URI, Predicate)
• ReflectionSupport.findAllResourcesInPackage(String, Predicate)
• ReflectionSupport.findAllResourcesInModule(String, Predicate)
• ReflectionSupport.streamAllResourcesInClasspathRoot(URI, Predicate)
• ReflectionSupport.streamAllResourcesInPackage(String, Predicate)
• ReflectionSupport.streamAllResourcesInModule(String, Predicate)

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.

Method Details

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