com.github.nosan.embedded.cassandra.commons

Interface Resource

All Known Implementing Classes:

ClassPathResource, FileSystemResource, UrlResource

public interface Resource

Resource that abstracts from the actual type of underlying source.

Since:

4.0.0

Author:

Dmytro Nosan

See Also:

ClassPathResource, FileSystemResource, UrlResource

Method Summary

Modifier and Type	Method and Description
boolean	exists() Tests whether a resource exists.
Optional<String>	getFileName() Gets the file name of this resource.
InputStream	getInputStream() Open an InputStream for the underlying resource.
OutputStream	getOutputStream() Open an OutputStream for the underlying resource.
boolean	isReadable() Tests whether a resource is readable.
boolean	isWritable() Tests whether a resource is writable.
default URI	toURI() Gets a URI to the underlying resource.
URL	toURL() Gets a URL to the underlying resource.

Method Detail

getFileName

Optional<String> getFileName()

Gets the file name of this resource.

Returns:

the name of this Resource.

exists

boolean exists()

Tests whether a resource exists.

Returns:

true if the resource exists

isWritable

boolean isWritable()

Tests whether a resource is writable.

Returns:

true if the resource exists and is writable

isReadable

boolean isReadable()

Tests whether a resource is readable.

Returns:

true if the resource exists and is readable

getInputStream

InputStream getInputStream()
                    throws IOException

Open an InputStream for the underlying resource.

Returns:

the input stream for the resource

Throws:

IOException - if resource does not exist or an I/O error occurs

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Open an OutputStream for the underlying resource.

Returns:

the output stream for the resource

Throws:

IOException - if resource does not exist or an I/O error occurs

toURL

URL toURL()
   throws IOException

Gets a URL to the underlying resource.

Returns:

the URL to the resource

Throws:

IOException - if resource does not exist, or URL cannot be built

toURI

default URI toURI()
           throws IOException

Gets a URI to the underlying resource.

Returns:

the URI to the resource

Throws:

IOException - if resource does not exist, or URI cannot be built