loci.formats.cache

Interface ICacheSource

All Known Implementing Classes:

BufferedImageSource, ByteArraySource, CacheSource, ImageProcessorSource

public interface ICacheSource

Interface for cache sources. A cache source returns objects in a defined order, from 0 to getObjectCount() - 1. The actual source of the objects is implementation-dependent; Bio-Formats uses IFormatReader to obtain image planes, but any ordered collection of objects can conceivably be cached.

Method Summary

Modifier and Type	Method and Description
Object	getObject(int index) Get the object corresponding to the given index.
int	getObjectCount() Get the total number of objects that this source can retrieve.

Method Detail

getObjectCount

int getObjectCount()
            throws CacheException

Get the total number of objects that this source can retrieve.

Throws:

CacheException

getObject

Object getObject(int index)
          throws CacheException

Get the object corresponding to the given index.

Throws:

CacheException