Package org.citrusframework.spi

Interface Resource

All Known Implementing Classes:

Resources.ByteArrayResource, Resources.ClasspathResource, Resources.FileSystemResource, Resources.UrlResource

public interface Resource

Describe a resource, such as a file or class path resource.

Method Summary

Modifier and Type	Method	Description
boolean	exists()	Whether this resource exists.
File	getFile()	Return the file associated with this resource.
InputStream	getInputStream()	Returns an InputStream that reads from the underlying resource.
String	getLocation()	The location of the resource.
default Reader	getReader()	Returns a Reader that reads from the underlying resource using UTF-8 as charset.
default Reader	getReader(Charset charset)	Returns a Reader that reads from the underlying resource using the given Charset
default URI	getURI()	The URI of the resource.
default URL	getURL()	The URL for the resource or null if the URL can not be computed.

Method Details

getLocation

String getLocation()

The location of the resource.

exists

boolean exists()

Whether this resource exists.

getURI

default URI getURI()

The URI of the resource.

The default implementation creates a URI object from resource location.

getURL

default URL getURL()
            throws MalformedURLException

The URL for the resource or null if the URL can not be computed.

The default implementation creates a URI object from resource location.

Throws:

MalformedURLException

getInputStream

InputStream getInputStream()

Returns an InputStream that reads from the underlying resource.

Each invocation must return a new InputStream instance.

getFile

File getFile()

Return the file associated with this resource.

Returns:

getReader

default Reader getReader()
                  throws IOException

Returns a Reader that reads from the underlying resource using UTF-8 as charset.

Each invocation must return a new Reader.

Throws:

IOException

See Also:

• getInputStream()

getReader

default Reader getReader(Charset charset)
                  throws IOException

Returns a Reader that reads from the underlying resource using the given Charset

Each invocation must return a new Reader.

Throws:

IOException

See Also:

• getInputStream()