to.etc.domui.caches

Class FileImageReference

java.lang.Object

to.etc.domui.caches.FileImageReference

All Implemented Interfaces:

Closeable, AutoCloseable, IImageReference

public class FileImageReference
extends Object
implements IImageReference

Constructor Summary

Constructors

Constructor and Description
FileImageReference(File source, String mime)

Method Summary

Modifier and Type	Method and Description
void	close()
InputStream	getInputStream() Returns the datastream containing this image.
String	getMimeType() This must return the image's actual mime type.
long	getVersionLong() If this retriever accesses resources that can change after use this must return some usable indication of the version, usually a "last date changed" timestamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileImageReference

public FileImageReference(File source,
                          String mime)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IImageReference

Throws:

IOException

getInputStream

public InputStream getInputStream()
                           throws Exception

Description copied from interface: IImageReference

Returns the datastream containing this image. This may be called only ONCE for an image and must be closed after use.

Specified by:

getInputStream in interface IImageReference

Returns:

Throws:

Exception

getMimeType

@Nonnull
public String getMimeType()
                            throws Exception

Description copied from interface: IImageReference

This must return the image's actual mime type.

Specified by:

getMimeType in interface IImageReference

Returns:

Throws:

Exception

getVersionLong

public long getVersionLong()
                    throws Exception

Description copied from interface: IImageReference

If this retriever accesses resources that can change after use this must return some usable indication of the version, usually a "last date changed" timestamp. This value should remain unchanged over invocations if the object accessed has not changed. It should return -1 if the source object has been deleted; it should return 0 if the timestamp does not matter. This gets called multiple times; it should be fast.

Specified by:

getVersionLong in interface IImageReference

Returns:

Throws:

Exception