to.etc.domui.util.images

Interface IImageRetriever

All Known Implementing Classes:

FileImageRetriever

public interface IImageRetriever

Factory to obtain an image's data from a per-retriever key string. UNSTABLE INTERFACE Thingy which can obtain images from some source (signal interface).

Author:

Frits Jalvingh Created on Oct 2, 2008

Method Summary

Modifier and Type	Method and Description
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)

Method Detail

getRetrieverKey

@Nonnull
String getRetrieverKey()

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.

Returns:

getCheckInterval

long getCheckInterval()

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.

Returns:

loadImage

@Nullable
IImageReference loadImage(@Nonnull
                                    String key)
                             throws Exception

Throws:

Exception