to.etc.domui.caches.images

Class ImageTask

java.lang.Object

to.etc.domui.caches.images.ImageTask

public class ImageTask
extends Object

Represents some action being handled within the image cache: the retrieval of some image. This separates the cache-based actions from the image-based actions.

Author:

Frits Jalvingh Created on Dec 1, 2009

Method Summary

Modifier and Type	Method and Description
void	addDeletedFragment(to.etc.domui.caches.images.CachedImageFragment ii)
void	addUsedFragment(to.etc.domui.caches.images.CachedImageFragment ii) Register an image as recently-used.
protected long	getCurrentVersionLong() If the version has not yet been retrieved for this task it gets retrieved; all calls following will use that version.
List<to.etc.domui.caches.images.CachedImageFragment>	getDeletedFragmentList()
Object	getFullImage(List<IImageConversionSpecifier> conversions)
to.etc.domui.caches.images.CachedImageData	getImageData(IImageConversionSpecifier[] conversions)
to.etc.domui.caches.images.CachedImageData	getImageData(List<IImageConversionSpecifier> conversions) This is the main workhorse for the image cache.
to.etc.domui.caches.images.CachedImageInfo	getImageInfo(List<IImageConversionSpecifier> conversions)
ImageKey	getKey()
to.etc.domui.caches.images.ImageRoot	getRoot()
List<to.etc.domui.caches.images.CachedImageFragment>	getUsedFragmentList()

Methods inherited from class java.lang.Object

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

Method Detail

getKey

public ImageKey getKey()

getRoot

public to.etc.domui.caches.images.ImageRoot getRoot()

getCurrentVersionLong

protected long getCurrentVersionLong()
                              throws Exception

If the version has not yet been retrieved for this task it gets retrieved; all calls following will use that version. The call must be done before any data gets read; this prevents the race condition where the record is changed between [read data] and [read version].

Returns:

Throws:

Exception

getImageData

public to.etc.domui.caches.images.CachedImageData getImageData(IImageConversionSpecifier[] conversions)
                                                        throws Exception

Throws:

Exception

getImageData

public to.etc.domui.caches.images.CachedImageData getImageData(List<IImageConversionSpecifier> conversions)
                                                        throws Exception

This is the main workhorse for the image cache. This retrieves a possible converted image off some source, using all kinds of caching to make it fast.

Parameters:

cacheKey -

sir -

conversions -

Returns:

Throws:

Exception

getImageInfo

public to.etc.domui.caches.images.CachedImageInfo getImageInfo(List<IImageConversionSpecifier> conversions)
                                                        throws Exception

Throws:

Exception

getFullImage

public Object getFullImage(List<IImageConversionSpecifier> conversions)
                    throws Exception

Throws:

Exception

addUsedFragment

public void addUsedFragment(@Nonnull
                            to.etc.domui.caches.images.CachedImageFragment ii)

Register an image as recently-used. The cache will relink it as used. Cannot be called for deleted images.

Parameters:

ii -

addDeletedFragment

public void addDeletedFragment(@Nonnull
                               to.etc.domui.caches.images.CachedImageFragment ii)

getUsedFragmentList

@Nonnull
public List<to.etc.domui.caches.images.CachedImageFragment> getUsedFragmentList()

getDeletedFragmentList

@Nonnull
public List<to.etc.domui.caches.images.CachedImageFragment> getDeletedFragmentList()