com.atakmap.android.util

Class FileCache

java.lang.Object

com.atakmap.android.util.ReservationService<java.io.File>

com.atakmap.android.util.FileCache

public class FileCache
extends ReservationService<java.io.File>

A ReservationService for a directory of files. Supports flushing of "stale" files. Files are "freshened" when they are reserved. Stale files are reserved during flushing, to avoid deletion of files that are in use.

Nested Class Summary

Nested classes/interfaces inherited from class com.atakmap.android.util.ReservationService

ReservationService.Reservation<T>

Constructor Summary

Constructors

Constructor and Description
FileCache(java.io.File cacheDir) Creates a FileCache for the supplied directory.

Method Summary

Modifier and Type	Method and Description
ReservationService.Reservation<java.io.File>	createReservation(java.io.File f) Creates a reservation containing the supplied item.
void	flushStaleCache(long staleness) Expunges from the cache those files that were last accessed longer ago than the supplied "staleness," expressed in milliseconds.
java.lang.String	getCachePath()

Methods inherited from class com.atakmap.android.util.ReservationService

isReserved, reserve, tryReserve, tryWithReservation, unreserve, withReservation

Methods inherited from class java.lang.Object

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

Constructor Detail

FileCache

public FileCache(java.io.File cacheDir)

Creates a FileCache for the supplied directory. The directory will be created if it does not already exist.

Parameters:

cacheDir - The directory to use for the cache.

Throws:

java.lang.IllegalArgumentException - If the supplied cacheDir is null, exists but is not a readable directory, or can't be created.

Method Detail

flushStaleCache

public void flushStaleCache(long staleness)

Expunges from the cache those files that were last accessed longer ago than the supplied "staleness," expressed in milliseconds. Files that are reserved are assumed to be fresh.

Parameters:

staleness - The maximum number of milliseconds ago a file must have been accessed to avoid being deleted from the cache.

getCachePath

public java.lang.String getCachePath()

createReservation

public ReservationService.Reservation<java.io.File> createReservation(java.io.File f)

Description copied from class: ReservationService

Creates a reservation containing the supplied item. Derived classes may override this method to perform additional work when a Reservation is created.

Overrides:

createReservation in class ReservationService<java.io.File>

Parameters:

f - The item being reserved.

Returns:

The Reservation token for the item.