org.osmdroid.tileprovider.modules

Interface IFilesystemCache

All Known Implementing Classes:

SqliteArchiveTileWriter, SqlTileWriter, TileWriter

public interface IFilesystemCache

Represents a write-only interface into a file system cache.

Method Summary

Modifier and Type	Method and Description
boolean	exists(ITileSource pTileSourceInfo, long pMapTileIndex) return true if the map file for download already exists
Long	getExpirationTimestamp(ITileSource pTileSource, long pMapTileIndex) Gets the cache expiration timestamp of a tile
Drawable	loadTile(ITileSource pTileSource, long pMapTileIndex) Gets the tile drawable
void	onDetach() Used when the map engine is shutdown, use it to perform any clean up activities and to terminate any background threads
boolean	remove(ITileSource tileSource, long pMapTileIndex) Removes a tile from the cache, see issue https://github.com/osmdroid/osmdroid/issues/426
boolean	saveFile(ITileSource pTileSourceInfo, long pMapTileIndex, InputStream pStream, Long pExpirationTime) Save an InputStream as the specified tile in the file system cache for the specified tile source.

Method Detail

saveFile

boolean saveFile(ITileSource pTileSourceInfo,
                 long pMapTileIndex,
                 InputStream pStream,
                 Long pExpirationTime)

Save an InputStream as the specified tile in the file system cache for the specified tile source.

Parameters:

pTileSourceInfo - a tile source

pMapTileIndex - a tile

pStream - an InputStream

Returns:

exists

boolean exists(ITileSource pTileSourceInfo,
               long pMapTileIndex)

return true if the map file for download already exists

Returns:

onDetach

void onDetach()

Used when the map engine is shutdown, use it to perform any clean up activities and to terminate any background threads

Since:

5.3

remove

boolean remove(ITileSource tileSource,
               long pMapTileIndex)

Removes a tile from the cache, see issue https://github.com/osmdroid/osmdroid/issues/426

Returns:

true if it was removed, false otherwise

Since:

5.4.2

getExpirationTimestamp

Long getExpirationTimestamp(ITileSource pTileSource,
                            long pMapTileIndex)

Gets the cache expiration timestamp of a tile

Returns:

cache expiration timestamp in time since UTC epoch (in milliseconds), or null if expiration timestamp is not supported or if the tile is not cached

Since:

5.6.5

loadTile

Drawable loadTile(ITileSource pTileSource,
                  long pMapTileIndex)
           throws Exception

Gets the tile drawable

Throws:

Exception

Since:

6.0.0