to.etc.domui.caches

Class FileImageRetriever

java.lang.Object

to.etc.domui.caches.FileImageRetriever

All Implemented Interfaces:

IImageRetriever

public class FileImageRetriever
extends Object
implements IImageRetriever

Constructor Summary

Constructors

Constructor and Description
FileImageRetriever()

Method Summary

Modifier and Type	Method and Description
static String	createFileURL(File what, String mime, String... convs) Creates a safe file reference.
long	getCheckInterval() Returns the check interval, in millis.
String	getRetrieverKey() Returns an unique string identifier, usable in file names and URL's, to represent all images obtained from this retriever.
IImageReference	loadImage(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileImageRetriever

public FileImageRetriever()

Method Detail

createFileURL

public static String createFileURL(File what,
                                   String mime,
                                   String... convs)

Creates a safe file reference. The key is stored in the session.

Parameters:

what -

Returns:

getCheckInterval

public long getCheckInterval()

Description copied from interface: IImageRetriever

Returns the check interval, in millis. This is the age that an image may have in the cache before it's rechecked for changes again. Returning 0 means the image gets checked for validity always.

Specified by:

getCheckInterval in interface IImageRetriever

Returns:

getRetrieverKey

@Nonnull
public String getRetrieverKey()

Description copied from interface: IImageRetriever

Returns an unique string identifier, usable in file names and URL's, to represent all images obtained from this retriever. Called once when the retriever is registered. The value returned by this call may not change over the lifetime of this factory.

Specified by:

getRetrieverKey in interface IImageRetriever

Returns:

loadImage

public IImageReference loadImage(@Nonnull
                                 String key)
                          throws Exception

Specified by:

loadImage in interface IImageRetriever

Throws:

Exception