CacheCleanupReceiver.java

package vandy.mooc.model.cache;

import android.app.PendingIntent;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;

/**
 * Broadcast receiver that will remove all the expired Weather data at regular
 * intervals.
 */
public class CacheCleanupReceiver 
       extends BroadcastReceiver {
    /**
     * Private request code for sender that is passed in an Intent.
     */
    public static final int DELETE_CACHE_REQUEST_CODE = 100;

    /**
     * Factory method to make a Pending Intent that is used by
     * AlarmManager to schedule Cache cleanup at regular intervals.
     * 
     * @param context
     * @return
     */
    public static PendingIntent makeReceiverPendingIntent(Context context) {
	// Use the Pending Intent that will send Intent to Receiver to
	// delete expired data from Database.
	return PendingIntent.getBroadcast(context, 
		DELETE_CACHE_REQUEST_CODE,
		new Intent(context, CacheCleanupReceiver.class),
		PendingIntent.FLAG_CANCEL_CURRENT);
    }

    /**
     * Factory method to make a Pending Intent that is used to check whether the
     * Alarm is already active or not.
     * 
     * @param context
     * @return
     */
    public static PendingIntent makeCheckAlarmPendingIntent(Context context) {
	// Check whether the Pending Intent already exists or not.
	return PendingIntent.getBroadcast(context, 
		DELETE_CACHE_REQUEST_CODE,
		new Intent(context, CacheCleanupReceiver.class),
		PendingIntent.FLAG_NO_CREATE);
    }

    /**
     * Hook method that is called when the BroadcastReceiver is receiving an
     * Intent broadcast.
     */
    @Override
    public void onReceive(Context context,
                          Intent intent) {
	// Create the TimeoutCache and remove all the expired Weather
	// data from the cache.
	new WeatherTimeoutCache(context).removeExpiredWeatherData();
    }
}