to.etc.domui.util.images

Interface IImageReference

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

FileImageReference

public interface IImageReference
extends Closeable

This is a reference to some individual original image as returned by IImageRetriever. It is a must-close resource.

Author:

Frits Jalvingh Created on Nov 30, 2009

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.

Method Detail

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getVersionLong

long getVersionLong()
             throws Exception

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.

Returns:

Throws:

Exception

getMimeType

@Nonnull
String getMimeType()
                     throws Exception

This must return the image's actual mime type.

Returns:

Throws:

Exception

getInputStream

InputStream getInputStream()
                    throws Exception

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

Returns:

Throws:

Exception