Package com.peterphi.std.guice.common.resource.iface

Interface ResourceProvider

All Known Implementing Classes:

ClasspathResourceProvider, FilesystemResourceProviderImpl

public interface ResourceProvider

Interface to a provider of resources.
Paths are specified in the style of a UNIX filepath, using "/" as a separator character.

Method Summary

Modifier and Type	Method	Description
InputStream	getBinaryResource(String name)	Loads a binary resource
PropertyFile	getPropertyResource(String name)	Loads a resource containing a property file
Reader	getTextResource(String name)	Loads a text resource.

Method Details

getBinaryResource

InputStream getBinaryResource(String name)
                       throws ResourceNotFoundException

Loads a binary resource

Parameters:

name - the resource name, expressed as a path (see the comments on ResourceProvider)

Returns:

Throws:

ResourceNotFoundException

getTextResource

Reader getTextResource(String name)
                throws ResourceNotFoundException

Loads a text resource. If it is necessary to make assumptions about the underlying encoding of a resource (e.g. the remote resource provider does not support then UTF-8 will be used

Parameters:

name - the resource name, expressed as a path using / as a separator character

Returns:

Throws:

ResourceNotFoundException

getPropertyResource

PropertyFile getPropertyResource(String name)
                          throws ResourceNotFoundException

Loads a resource containing a property file

Parameters:

name - the resource name, expressed as a path with / characters to separate

Returns:

Throws:

ResourceNotFoundException