org.osmdroid.tileprovider.modules

Class TileWriter

java.lang.Object

org.osmdroid.tileprovider.modules.TileWriter

All Implemented Interfaces:

IFilesystemCache

public class TileWriter
extends Object
implements IFilesystemCache

An implementation of IFilesystemCache. It writes tiles to the file system cache. If the cache exceeds 600 Mb then it will be trimmed to 500 Mb.

See Also:

OpenStreetMapTileProviderConstants

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static boolean	hasInited
(package private) Thread	initThread

Constructor Summary

Constructors

Constructor and Description
TileWriter()

Method Summary

Modifier and Type	Method and Description
boolean	exists(ITileSource pTileSource, 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
File	getFile(ITileSource pTileSource, long pMapTileIndex)
static long	getUsedCacheSpace() Get the amount of disk space used by the tile cache.
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 pTileSource, long pMapTileIndex) Removes a tile from the cache, see issue https://github.com/osmdroid/osmdroid/issues/426
boolean	saveFile(ITileSource pTileSource, long pMapTileIndex, InputStream pStream, Long pExpirationTime) Save an InputStream as the specified tile in the file system cache for the specified tile source.
void	setMaximumCachedFileAge(long mMaximumCachedFileAge)

Methods inherited from class java.lang.Object

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

Field Detail

hasInited

static boolean hasInited

initThread

Thread initThread

Constructor Detail

TileWriter

public TileWriter()

Method Detail

getUsedCacheSpace

public static long getUsedCacheSpace()

Get the amount of disk space used by the tile cache. This will initially be zero since the used space is calculated in the background.

Returns:

size in bytes

setMaximumCachedFileAge

public void setMaximumCachedFileAge(long mMaximumCachedFileAge)

saveFile

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

Description copied from interface: IFilesystemCache

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

Specified by:

saveFile in interface IFilesystemCache

Parameters:

pTileSource - a tile source

pMapTileIndex - a tile

pStream - an InputStream

Returns:

onDetach

public void onDetach()

Description copied from interface: IFilesystemCache

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

Specified by:

onDetach in interface IFilesystemCache

remove

public boolean remove(ITileSource pTileSource,
                      long pMapTileIndex)

Description copied from interface: IFilesystemCache

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

Specified by:

remove in interface IFilesystemCache

Returns:

true if it was removed, false otherwise

getFile

public File getFile(ITileSource pTileSource,
                    long pMapTileIndex)

Since:

5.6.5

exists

public boolean exists(ITileSource pTileSource,
                      long pMapTileIndex)

Description copied from interface: IFilesystemCache

return true if the map file for download already exists

Specified by:

exists in interface IFilesystemCache

Returns:

getExpirationTimestamp

public Long getExpirationTimestamp(ITileSource pTileSource,
                                   long pMapTileIndex)

Description copied from interface: IFilesystemCache

Gets the cache expiration timestamp of a tile

Specified by:

getExpirationTimestamp in interface IFilesystemCache

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

loadTile

public Drawable loadTile(ITileSource pTileSource,
                         long pMapTileIndex)
                  throws Exception

Description copied from interface: IFilesystemCache

Gets the tile drawable

Specified by:

loadTile in interface IFilesystemCache

Throws:

Exception