JUnit 6.0.1 · org.junit.platform.commons.io.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.

Method Summary

Modifier and Type	Method and Description
public default InputStream	Returns: an input stream for this resource; never `null` getInputStream() Get an `InputStream` for reading this resource.
public String	Returns: the resource name; never `null` getName() Get the name of this resource.
public URI	Returns: the URI of the resource; never `null` getUri() Get the URI of this resource.
public static Resource	Returns: a new `Resource` of(String the name of the resource; never `null` name, URI the URI of the resource; never `null` uri) Create a new `Resource` with the given name and URI.

getInputStream back to summary

getInputStream	back to summary
public default InputStream getInputStream() throws IOException Get an `InputStream` for reading this resource. The default implementation delegates to `java.net.URL#openStream()` for this resource's `URI`. Returns:InputStream an input stream for this resource; never `null` Exceptions IOException: if an I/O exception occurs

public default InputStream getInputStream() throws IOException

Get an InputStream for reading this resource.

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

an input stream for this resource; never null

Exceptions

getName back to summary

getName	back to summary
public 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:String the resource name; never `null`

public 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.

getUri back to summary

getUri	back to summary
public URI getUri() Get the URI of this resource. Returns:URI the URI of the resource; never `null`

public URI getUri()

Get the URI of this resource.

of back to summary

of	back to summary
public static Resource of(String name, URI uri) Create a new `Resource` with the given name and URI. Parameters name:String the name of the resource; never `null` uri:URI the URI of the resource; never `null` Returns:Resource a new `Resource` Since 1.14

public static Resource of(String name, URI uri)

Create a new Resource with the given name and URI.

Parameters

a new Resource

Since

1.14