au.com.codeka.carrot.resource

Interface ResourceLocator

All Known Implementing Classes:

FileResourceLocator, MemoryResourceLocator

public interface ResourceLocator

Used to resolve resource names to actual files.

While conceptually file-based, this could actually be implemented on top of anything.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResourceLocator.Builder

Method Summary

Modifier and Type	Method and Description
ResourceName	findResource(ResourceName parent, java.lang.String name) Searches for a resource with the given name, returns the full path to it.
ResourceName	findResource(java.lang.String name) Searches for a resource with the given name, returns the full path to it.
long	getModifiedTime(ResourceName resourceName) Gets a value which indicates when the resource was modified.
java.io.Reader	getReader(ResourceName resourceName) Gets a Reader to read the contents of the given resource.

Method Detail

findResource

ResourceName findResource(@Nullable
                          ResourceName parent,
                          java.lang.String name)
                   throws CarrotException

Searches for a resource with the given name, returns the full path to it.

This will search for the resource in the given path first, if not found there will search a locator-specific search path for the resource before giving up.

Parameters:

parent - The parent to look for the resource in. If not found here, we will also do a search for a non-relative name. May be null to search only in the search path.

name - The name of the resource to search file.

Returns:

A ResourceName representing the resolved name of the resource.

Throws:

CarrotException - If the resource cannot be found.

findResource

ResourceName findResource(java.lang.String name)
                   throws CarrotException

Searches for a resource with the given name, returns the full path to it.

Parameters:

name - The name of the resource to search file.

Returns:

A ResourceName representing the resolved name of the resource.

Throws:

CarrotException - If the resource cannot be found.

getModifiedTime

long getModifiedTime(ResourceName resourceName)
              throws CarrotException

Gets a value which indicates when the resource was modified. This could be a timestamp, but it could also be a hash, the actual value doesn't matter as long as it's different when the resource is modified.

The value is used to determine whether we need to flush our caches, and this function will be called for every request to render a template, so calling this needs to be quick.

Zero indicates this ResourceLocator doesn't support modification detection, and resources will be cached indefinitely.

Parameters:

resourceName - The ResourceName of the resource.

Returns:

A value indicating the 'last modified time' (or a hash) of the resource.

Throws:

CarrotException - If the resource cannot be found.

getReader

java.io.Reader getReader(ResourceName resourceName)
                  throws CarrotException

Gets a Reader to read the contents of the given resource.

Parameters:

resourceName - The ResourceName of the resource.

Returns:

A Reader for reading the contents of the resource.

Throws:

CarrotException - If the resource cannot be found.