au.com.codeka.carrot.resource

Class FileResourceLocator

java.lang.Object

au.com.codeka.carrot.resource.FileResourceLocator

All Implemented Interfaces:

ResourceLocator

public class FileResourceLocator
extends java.lang.Object
implements ResourceLocator

An implementation of ResourceLocator that loads files from the file system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileResourceLocator.Builder A builder for FileResourceLocator.

Constructor Summary

Constructors

Constructor and Description
FileResourceLocator(Configuration config, java.lang.String basePath) Constructs a new FileResourceLocator using the given Configuration and base path to search for resources in.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileResourceLocator

public FileResourceLocator(Configuration config,
                           java.lang.String basePath)

Constructs a new FileResourceLocator using the given Configuration and base path to search for resources in.

Parameters:

config - The Configuration you used to construct the CarrotEngine.

basePath - The path path to search for resources in.

Method Detail

findResource

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

Description copied from interface: ResourceLocator

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.

Specified by:

findResource in interface ResourceLocator

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

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

Description copied from interface: ResourceLocator

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

Specified by:

findResource in interface ResourceLocator

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

public long getModifiedTime(ResourceName resourceName)
                     throws CarrotException

Description copied from interface: ResourceLocator

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.

Specified by:

getModifiedTime in interface ResourceLocator

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

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

Description copied from interface: ResourceLocator

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

Specified by:

getReader in interface ResourceLocator

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.