com.twofortyfouram.spackle.power

Class PartialWakeLockForService

java.lang.Object

com.twofortyfouram.spackle.power.PartialWakeLockForService

@ThreadSafe
public final class PartialWakeLockForService
extends Object

Manages a partial WakeLock for Service in a thread-safe manner. The recommended way to use this class is as follows:

1. Create a private static final instance of PartialWakeLockForService within the Service subclass that needs a WakeLock.
2. Create a public static method for the Service class that will encapsulate calling beforeStartingService(Context) and Context.startService(Intent).
3. Within the Service implementation, call beforeDoingWork(Context), and afterDoingWork(Context) at the appropriate times.

This class handles scenarios where beforeStartingService(Context) isn't always called (for example, the Service is restarted due to Service.START_STICKY or similar).

Clients of this class must have the permission Manifest.permission.WAKE_LOCK.

Constructor Summary

Constructors

Constructor and Description
PartialWakeLockForService(String name) Construct a new WakeLock helper.

Method Summary

Modifier and Type	Method and Description
void	afterDoingWork(Context context) Call to issue after the service completes its work.
void	beforeDoingWork(Context context) Call to issue within prior to starting the service's work, typically in either Service.onStartCommand(android.content.Intent, int, int) or IntentService.onHandleIntent(Intent).
void	beforeStartingService(Context context) Call to issue immediately before calling ContextWrapper.startService(android.content.Intent).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PartialWakeLockForService

public PartialWakeLockForService(String name)

Construct a new WakeLock helper.

Parameters:

name - Name of the WakeLock, used for debugging. Cannot be the empty string.

Method Detail

beforeStartingService

public void beforeStartingService(Context context)

Call to issue immediately before calling ContextWrapper.startService(android.content.Intent).

Parameters:

context - Application context.

beforeDoingWork

public void beforeDoingWork(Context context)

Call to issue within prior to starting the service's work, typically in either Service.onStartCommand(android.content.Intent, int, int) or IntentService.onHandleIntent(Intent).

Parameters:

context - Application context.

afterDoingWork

public void afterDoingWork(Context context)

Call to issue after the service completes its work.

This method MUST always be called, otherwise locks obtained previously by beforeStartingService(Context) or beforeDoingWork(Context) may never be released. Typically, this should be placed in a finally block within Service.onStartCommand(android.content.Intent, int, int) or IntentService.onHandleIntent(Intent).

Parameters:

context - Application context.

toString

public String toString()

Overrides:

toString in class Object