com.birbit.android.jobqueue

Class CancelResult

java.lang.Object

com.birbit.android.jobqueue.CancelResult

public class CancelResult
extends java.lang.Object

This class holds the result of a cancel request via JobManager.cancelJobs(TagConstraint, String...) or JobManager.cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...).

Cancelling jobs is an expensive operation because it requires JobManager to deserializer the job from databases and call onCancel method on it.

When cancelling jobs, if you need to get the list of cancelled jobs, you can provide this callback to JobManager.cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CancelResult.AsyncCancelCallback

Constructor Summary

Constructors

Constructor and Description
CancelResult()
CancelResult(java.util.Collection<Job> cancelledJobs, java.util.Collection<Job> failedToCancel)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Job>	getCancelledJobs()
java.util.Collection<Job>	getFailedToCancel()

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelResult

public CancelResult()

CancelResult

public CancelResult(java.util.Collection<Job> cancelledJobs,
                    java.util.Collection<Job> failedToCancel)

Method Detail

getCancelledJobs

public java.util.Collection<Job> getCancelledJobs()

Returns:

The list of jobs that are cancelled before they did run

getFailedToCancel

public java.util.Collection<Job> getFailedToCancel()

Returns:

The list of jobs that were running when cancel was called and onFinished running successfully before they could be cancelled.