Remove deprecated BaseJob

Add onCancel guarantee for jobs canceled by the user. Previous, job was
removed from disk instantly and if app termniates before onCancel is called,
job would not get a chance to clean after itself.

This CL also adds a test mode to job manager configuration to use in
memory database for persistent queue.

Author: yigit

README.md

@@ -41,7 +41,7 @@ Although not required, it is most useful when used with an event bus. It also su
 
 Since a code example is worth thousands of documentation pages, here it is.
 
-File: [PostTweetJob.java](https://github.com/path/android-priority-jobqueue/blob/master/examples/twitter/TwitterClient/src/com/path/android/jobqueue/examples/twitter/jobs/PostTweetJob.java)
+File: [PostTweetJob.java](https://github.com/yigit/android-priority-jobqueue/blob/master/examples/twitter/TwitterClient/src/com/path/android/jobqueue/examples/twitter/jobs/PostTweetJob.java)
 ``` java
 // A job to send a tweet
 public class PostTweetJob extends Job {
@@ -77,7 +77,7 @@ public class PostTweetJob extends Job {
 
 ```
 
-File: [TweetActivity.java](https://github.com/path/android-priority-jobqueue/blob/master/examples/twitter/TwitterClient/src/com/path/android/jobqueue/examples/twitter/SampleTwitterClient.java#L53)
+File: [TweetActivity.java](https://github.com/yigit/android-priority-jobqueue/blob/master/examples/twitter/TwitterClient/src/com/path/android/jobqueue/examples/twitter/SampleTwitterClient.java#L53)
 ``` java
 //...
 public void onSendClick() {
@@ -129,15 +129,15 @@ At Path, we use [greenrobot's EventBus](https://github.com/greenrobot/EventBus);
 ### Getting Started
 We distribute artifacts through maven central repository.
 
-Gradle: `compile 'com.path:android-priority-jobqueue:1.1.2'`
+Gradle: `compile 'com.birbit:android-priority-jobqueue:1.1.3'`
 
 Maven:
 
 ``` xml
 <dependency>
-    <groupId>com.path</groupId>
+    <groupId>com.birbit</groupId>
     <artifactId>android-priority-jobqueue</artifactId>
-    <version>1.1.2</version>
+    <version>1.1.3</version>
 </dependency>
 ```
 
@@ -150,6 +150,10 @@ We highly recommend checking how you can configure job manager and individual jo
 * [Review sample configuration][7]
 
 ### Version History
+  - 1.1.3 (March 21, 2015)
+   - Ability to add tags to jobs. These tags can be used to later retrieve jobs.
+   - Added long awaited job cancellation. You can use tags to cancel jobs.
+   - Removed deprecated BaseJob class. This may break backward compatibility.
   - 1.1.2 (Feb 18, 2014)
    - Report exceptions to logger if addInBackground fails. (#31)
   - 1.1.1 (Feb 8, 2014)
@@ -224,15 +228,15 @@ THE SOFTWARE.
 </pre>
 
 
-[1]: https://github.com/path/android-priority-jobqueue/blob/master/jobqueue/src/com/path/android/jobqueue/network/NetworkUtil.java
-[2]: https://github.com/path/android-priority-jobqueue/blob/master/jobqueue/src/com/path/android/jobqueue/network/NetworkEventProvider.java
+[1]: https://github.com/yigit/android-priority-jobqueue/blob/master/jobqueue/src/com/path/android/jobqueue/network/NetworkUtil.java
+[2]: https://github.com/yigit/android-priority-jobqueue/blob/master/jobqueue/src/com/path/android/jobqueue/network/NetworkEventProvider.java
 [3]: http://path.github.io/android-priority-jobqueue/coverage-report/index.html
 [4]: http://path.github.io/android-priority-jobqueue/javadoc/index.html
 [5]: http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22android-priority-jobqueue%22
-[6]: https://github.com/path/android-priority-jobqueue/tree/master/examples
-[7]: https://github.com/path/android-priority-jobqueue/blob/master/examples/twitter/TwitterClient/src/com/path/android/jobqueue/examples/twitter/TwitterApplication.java#L26
+[6]: https://github.com/yigit/android-priority-jobqueue/tree/master/examples
+[7]: https://github.com/yigit/android-priority-jobqueue/blob/master/examples/twitter/TwitterClient/src/com/path/android/jobqueue/examples/twitter/TwitterApplication.java#L26
 [8]: http://www.youtube.com/watch?v=xHXn3Kg2IQE
-[9]: https://github.com/path/android-priority-jobqueue/wiki
-[10]: https://github.com/path/android-priority-jobqueue/wiki/Job-Manager-Configuration
-[11]: https://github.com/path/android-priority-jobqueue/wiki/Job-Configuration
-[12]: https://github.com/path/android-priority-jobqueue/blob/master/jobqueue/src/com/path/android/jobqueue/Params.java
+[9]: https://github.com/yigit/android-priority-jobqueue/wiki
+[10]: https://github.com/yigit/android-priority-jobqueue/wiki/Job-Manager-Configuration
+[11]: https://github.com/yigit/android-priority-jobqueue/wiki/Job-Configuration
+[12]: https://github.com/yigit/android-priority-jobqueue/blob/master/jobqueue/src/com/path/android/jobqueue/Params.java

examples/twitter/TwitterClient/build.gradle

@@ -59,7 +59,7 @@ android {
     dependencies {
         compile 'de.greenrobot:eventbus:2.1.0-beta-1'
         compile 'org.twitter4j:twitter4j-core:3.0.5'
-        compile 'com.path:android-priority-jobqueue:1.1-SNAPSHOT'
+        compile 'com.path:android-priority-jobqueue:1.1 -SNAPSHOT'
         compile files('external-libs/greenDAO.jar')
     }
 

jobqueue/AndroidManifest.xml

@@ -2,7 +2,7 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
           package="com.path.android.jobqueue"
           android:versionCode="2"
-          android:versionName="1.3-SNAPSHOT">
+          android:versionName="1.3">
     <application android:label="">
     </application>
 </manifest>

jobqueue/build.xml

@@ -158,7 +158,7 @@
     </target>
 
     <target name="coverage-report">
-        <cobertura-report format="html" destdir="${coveragereport.dir}" srcdir="${src.dir}"/>
+        <cobertura-report format="html" destdir="coverage-report" srcdir="${src.dir}"/>
     </target>
 
     <target name="build-jar" depends="release" description="builds jar from compiled code">

jobqueue/src/com/path/android/jobqueue/BaseJob.java

@@ -2,34 +2,38 @@
 
 import java.util.Collection;
 import java.util.HashSet;
+import com.path.android.jobqueue.JobManager;
 
 /**
- * Canceling jobs is an expensive operation because it requires JobManager to deserializer the job
+ * This class holds the result of a cancel request via {@link JobManager#cancelJobs(TagConstraint, String...)}
+ * or {@link JobManager#cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...)}.
+ * <p>
+ * Cancelling jobs is an expensive operation because it requires JobManager to deserializer the job
  * from databases and call onCancel method on it.
  * <p>
- * When cancelling jobs, if you need to get the list of canceled jobs, you can provide this
+ * When cancelling jobs, if you need to get the list of cancelled jobs, you can provide this
  * callback to {@link JobManager#cancelJobsInBackground(CancelResult.AsyncCancelCallback, TagConstraint, String...)}
  * method.
  */
 public class CancelResult {
-    Collection<Job> canceledJobs;
+    Collection<Job> cancelledJobs;
     Collection<Job> failedToCancel;
 
     public CancelResult() {
-        this.canceledJobs = new HashSet<Job>();
+        this.cancelledJobs = new HashSet<Job>();
         this.failedToCancel = new HashSet<Job>();
     }
 
     /**
-     * @return The list of jobs that are canceled before they did run
+     * @return The list of jobs that are cancelled before they did run
      */
-    public Collection<Job> getCanceledJobs() {
-        return canceledJobs;
+    public Collection<Job> getCancelledJobs() {
+        return cancelledJobs;
     }
 
     /**
      * @return The list of jobs that were running when cancel was called and finished running
-     * successfully before they could be canceled.
+     * successfully before they could be cancelled.
      */
     public Collection<Job> getFailedToCancel() {
         return failedToCancel;
@@ -40,6 +44,6 @@ public static interface AsyncCancelCallback {
         /**
          * When job cancellation is complete, this method is called by the JobManager.
          */
-        public void onCanceled(CancelResult cancelResult);
+        public void onCancelled(CancelResult cancelResult);
     }
 }