Interface StorageManager

Package world.mappable.mapkit.storage

interface StorageManager

Storage manager.

This is a manager that controls temporary cache storages (for example map tiles).

SummarySummary

MethodsMethods

Type and modifiers	Method and Description
void	addStorageErrorListener(@NonNull StorageErrorListener errorListener) Subscribes to storage events.
void	removeStorageErrorListener(@NonNull StorageErrorListener errorListener) Unsubscribes from storage events.
void	computeSize(@NonNull SizeListener callback) Computes storage size in bytes.
void	clear(@NonNull ClearListener callback) Removes all data.
void	setMaxTileStorageSize(long limit,                       @NonNull SizeListener callback) Sets the maximum tile cache size to limit bytes.
void	resetMaxTileStorageSize(@NonNull SizeListener callback) Resets the tile cache size limit.
void	maxTileStorageSize(@NonNull SizeListener callback) Obtains the current storage size limit in bytes.
boolean	isValid() Tells if this StorageManager is valid or not.

MethodsMethods

addStorageErrorListeneraddStorageErrorListener

void addStorageErrorListener(@NonNull StorageErrorListener errorListener)

Subscribes to storage events.

The class does not retain the object in the 'errorListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

removeStorageErrorListenerremoveStorageErrorListener

void removeStorageErrorListener(@NonNull StorageErrorListener errorListener)

Unsubscribes from storage events.

computeSizecomputeSize

void computeSize(@NonNull SizeListener callback)

Computes storage size in bytes.

clearclear

void clear(@NonNull ClearListener callback)

Removes all data.

setMaxTileStorageSizesetMaxTileStorageSize

void setMaxTileStorageSize(long limit,                            @NonNull SizeListener callback)

Sets the maximum tile cache size to limit bytes.

When the limit is reached, old tiles are removed.

resetMaxTileStorageSizeresetMaxTileStorageSize

void resetMaxTileStorageSize(@NonNull SizeListener callback)

Resets the tile cache size limit.

maxTileStorageSizemaxTileStorageSize

void maxTileStorageSize(@NonNull SizeListener callback)

Obtains the current storage size limit in bytes.

isValidisValid

boolean isValid()

Tells if this StorageManager is valid or not.

Any other method (except for this one) called on an invalid StorageManager will throw java.lang.RuntimeException. An instance becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.