com.google.clearsilver.jsilver.adaptor
Class ResourceLoaderAdaptor

java.lang.Object
  extended by com.google.clearsilver.jsilver.adaptor.ResourceLoaderAdaptor
All Implemented Interfaces:
ResourceLoader

public class ResourceLoaderAdaptor
extends Object
implements ResourceLoader

Wrap a CSFileLoader with a ResourceLoader


Method Summary
 void close(Reader reader)
          Close the reader.
 Object getKey(String filename)
          Returns an object that can be used to uniquely identify the file corresponding to the given file name in the context of this ResourceLoader.
 Object getResourceVersionId(String filename)
          Some applications, e.g.
 Reader open(String name)
          Open a resource.
 Reader openOrFail(String name)
          Open a resource or throw an exception if no such resource is found.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

open

public Reader open(String name)
            throws IOException
Description copied from interface: ResourceLoader
Open a resource. If this resource is not found, null should be returned. The caller of this method is guaranteed to call ResourceLoader.close(Reader) when done with the reader.

Specified by:
open in interface ResourceLoader
Parameters:
name - the name of the resource
Returns:
Reader, or null if not found.
Throws:
IOException - if resource fails to open

openOrFail

public Reader openOrFail(String name)
                  throws JSilverTemplateNotFoundException,
                         IOException
Description copied from interface: ResourceLoader
Open a resource or throw an exception if no such resource is found. The caller of this method is guaranteed to call ResourceLoader.close(Reader) when done with the reader.

Specified by:
openOrFail in interface ResourceLoader
Parameters:
name - the name of the resource
Returns:
Reader, or null if not found.
Throws:
JSilverTemplateNotFoundException - if resource is not found
IOException - if resource fails to open

close

public void close(Reader reader)
           throws IOException
Description copied from interface: ResourceLoader
Close the reader. Allows ResourceLoader to perform any additional clean up.

Specified by:
close in interface ResourceLoader
Parameters:
reader - the reader to close
Throws:
IOException - if reader fasils to close

getKey

public Object getKey(String filename)
Description copied from interface: ResourceLoader
Returns an object that can be used to uniquely identify the file corresponding to the given file name in the context of this ResourceLoader. (e.g. ordered list of directories + filename, or absolute file path.).

Specified by:
getKey in interface ResourceLoader
Parameters:
filename - the name we want to identify
Returns:
unique identifier

getResourceVersionId

public Object getResourceVersionId(String filename)
Some applications, e.g. online help, need to know when a file has changed due to a symlink modification hence the use of File.getCanonicalFile(), if possible.

Specified by:
getResourceVersionId in interface ResourceLoader
Parameters:
filename - the name of the resource to check for resources
Returns:
unique identifier for the current version of the resource or null if the resource cannot be found


Copyright © 2010-2012 Google. All Rights Reserved.