Merge branch 'develop'

Author: Rolf-Smit

DOCUMENTATION.md

@@ -229,9 +229,15 @@ public class MyBaseActivity extends SomeActivity implements TaskManagerOwner {
 
     @Override
     protected void onStop() {
-        proxy.onStop();
+        proxy.onStop(); // Call before super!
         super.onStop();
     }
+    
+    @Override
+    protected void onDestroy() {
+        proxy.onDestroy(); // Call before super!
+        super.onDestroy();
+    }
 
     @Override
     public TaskManager getTaskManager() {

README.md

@@ -53,10 +53,10 @@ Android-Retainable-Tasks is available on jcenter just like many other Android/Ja
 ```groovy
 dependencies {
     // The library dependency
-    compile 'org.neotech.library:android-retainable-tasks:1.0.0-rc-1'
+    compile 'org.neotech.library:android-retainable-tasks:1.0.0-rc-2'
     
     // Needed if you want to use annotations
-    annotationProcessor 'org.neotech.library:android-retainable-tasks-compiler:1.0.0-rc-1'
+    annotationProcessor 'org.neotech.library:android-retainable-tasks-compiler:1.0.0-rc-2'
 }
 ```
 

annotations-processor/src/main/java/org/neotech/library/retainabletasks/AnnotationsProcessor.java

@@ -157,18 +157,7 @@ private JavaFile createJavaFile(TypeElement forTypeElement, TaskBindingContainer
             callbackImplementation.addMethod(createTaskCallbackMethod("onPreExecute", methods.getElementForPreExecute()));
             callbackImplementation.addMethod(createTaskCallbackMethod("onPostExecute", methods.getElementForPostExecute()));
             callbackImplementation.addMethod(createTaskCallbackMethod("onCanceled", methods.getElementForCancel()));
-
-            MethodSpec.Builder progressUpdateMethod = MethodSpec.methodBuilder("onProgressUpdate")
-                    .addAnnotation(Override.class)
-                    .addModifiers(Modifier.PUBLIC)
-                    .addParameter(CLASS_TASK, "task")
-                    .addParameter(TypeName.OBJECT, "object");
-
-            if(methods.getElementForProgress() != null) {
-                progressUpdateMethod.addStatement("target.$L(task, object)", methods.getElementForProgress().getSimpleName());
-            }
-            callbackImplementation.addMethod(progressUpdateMethod.build());
-
+            callbackImplementation.addMethod(createTaskCallbackMethodForProgress(methods.getElementForProgress()));
 
             if(methods.getElementForAttach() != null) {
                 final boolean onlyCallOnReAttach = methods.getElementForAttach().getAnnotation(TaskAttach.class).onlyCallOnReAttach();
@@ -179,7 +168,21 @@ private JavaFile createJavaFile(TypeElement forTypeElement, TaskBindingContainer
                 if(parameters.size() == 0) {
                     getListenerForMethod.addStatement("target.$L()", methods.getElementForAttach().getSimpleName());
                 } else {
-                    getListenerForMethod.addStatement("target.$L(task)", methods.getElementForAttach().getSimpleName());
+                    // One parameter, check it and call the method.
+                    final VariableElement parameter = parameters.get(0);
+                    final TypeMirror taskType = processingEnv.getTypeUtils().erasure(processingEnv.getElementUtils().getTypeElement(CLASS_TASK.reflectionName()).asType());
+
+                    if (!processingEnv.getTypeUtils().isAssignable(parameter.asType(), taskType)) {
+                        // Parameter not an instance of Task
+                        error(parameter, "Type of parameter '%s' is not an instance of '%s'!", parameter.getSimpleName(), taskType);
+                    } else {
+                        // Check if the class to cast too is accessible.
+                        final Element requiredElement = processingEnv.getTypeUtils().asElement(parameter.asType());
+                        if (!requiredElement.getModifiers().contains(Modifier.PUBLIC) && !requiredElement.getModifiers().contains(Modifier.PROTECTED)) {
+                            error(parameter, "Type of parameter '%s' is not public or protected accessible! This prevents Android-Retainable-Tasks from casting '%s' to '%s'.\nTo fix this either the type of the parameter or make the class accessible by adding the public or protected modifier!", parameter.getSimpleName(), taskType, parameter.asType().toString());
+                        }
+                        getListenerForMethod.addStatement("target.$L(($T) task)", methods.getElementForAttach().getSimpleName(), parameter.asType());
+                    }
                 }
                 if(onlyCallOnReAttach){
                     getListenerForMethod.endControlFlow();
@@ -210,6 +213,47 @@ private JavaFile createJavaFile(TypeElement forTypeElement, TaskBindingContainer
                 .build();
     }
 
+    private MethodSpec createTaskCallbackMethodForProgress(@Nullable Element progressElement){
+        MethodSpec.Builder progressUpdateMethod = MethodSpec.methodBuilder("onProgressUpdate")
+                .addAnnotation(Override.class)
+                .addModifiers(Modifier.PUBLIC)
+                .addParameter(CLASS_TASK, "task")
+                .addParameter(TypeName.OBJECT, "object");
+
+        if(progressElement != null) {
+            final List<? extends VariableElement> parameters = ((ExecutableElement) progressElement).getParameters();
+            if(parameters.size() == 0) {
+                progressUpdateMethod.addStatement("target.$L()", progressElement.getSimpleName());
+            } else if(parameters.size() >= 1 && parameters.size() <= 2){
+                // One or two parameters, check it and call the method.
+                final VariableElement parameterTask = parameters.get(0);
+                final TypeMirror taskType = processingEnv.getTypeUtils().erasure(processingEnv.getElementUtils().getTypeElement(CLASS_TASK.reflectionName()).asType());
+
+                if (!processingEnv.getTypeUtils().isAssignable(parameterTask.asType(), taskType)) {
+                    // Parameter not an instance of Task
+                    error(parameterTask, "Type of parameter '%s' is not an instance of '%s'!", parameterTask.getSimpleName(), taskType);
+                    return progressUpdateMethod.build();
+                }
+                // Check if the class to cast to is accessible.
+                final Element requiredElement = processingEnv.getTypeUtils().asElement(parameterTask.asType());
+                if (!requiredElement.getModifiers().contains(Modifier.PUBLIC) && !requiredElement.getModifiers().contains(Modifier.PROTECTED)) {
+                    error(parameterTask, "Type of parameter '%s' is not public or protected accessible! This prevents Android-Retainable-Tasks from casting '%s' to '%s'.\nTo fix this either the type of the parameter or make the class accessible by adding the public or protected modifier!", parameterTask.getSimpleName(), taskType, parameterTask.asType().toString());
+                    return progressUpdateMethod.build();
+                }
+
+                if(parameters.size() == 2){
+                    progressUpdateMethod.addStatement("target.$L(($T) task, object)", progressElement.getSimpleName(), parameterTask.asType());
+                } else {
+                    progressUpdateMethod.addStatement("target.$L(($T) task)", progressElement.getSimpleName(), parameterTask.asType());
+                }
+
+            } else {
+                progressUpdateMethod.addComment("No annotated method found for $L", progressElement.getSimpleName());
+            }
+        }
+        return progressUpdateMethod.build();
+    }
+
     private MethodSpec createTaskCallbackMethod(String methodName, @Nullable Element methodToCall){
         // Create the implementation of the onPreExecute method.
         final MethodSpec.Builder onPreExecuteMethod = MethodSpec.methodBuilder(methodName)

demo/build.gradle

@@ -1,13 +1,13 @@
 apply plugin: 'com.android.application'
 
 android {
-    compileSdkVersion 25
+    compileSdkVersion 26
     buildToolsVersion '25.0.3'
 
     defaultConfig {
         applicationId "org.neotech.app.retainabletasksdemo"
         minSdkVersion 14
-        targetSdkVersion 25
+        targetSdkVersion 26
         versionCode 1
         versionName "1.0"
     }
@@ -23,10 +23,10 @@ dependencies {
     compile project(':library')
     compile project(":annotations")
     annotationProcessor project(":annotations-processor")
-    //compile 'org.neotech.library:android-retainable-tasks:1.0.0-rc-1'
+    //compile 'org.neotech.library:android-retainable-tasks:1.0.0-rc-2'
 
-    compile 'com.android.support:appcompat-v7:25.3.1'
-    compile 'com.android.support:design:25.3.1'
+    compile 'com.android.support:appcompat-v7:26.0.2'
+    compile 'com.android.support:design:26.0.2'
 
     //LeakCanary is used to detect memory leaks in debug builds.
     debugCompile 'com.squareup.leakcanary:leakcanary-android:1.5.1'

demo/src/main/java/org/neotech/app/retainabletasksdemo/activity/Main.java

@@ -21,6 +21,7 @@
 import org.neotech.app.retainabletasksdemo.R;
 import org.neotech.library.retainabletasks.Task;
 import org.neotech.library.retainabletasks.TaskAttach;
+import org.neotech.library.retainabletasks.TaskManager;
 import org.neotech.library.retainabletasks.TaskPostExecute;
 import org.neotech.library.retainabletasks.providers.TaskActivityCompat;
 
@@ -40,6 +41,8 @@ protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
+        getSupportActionBar().setSubtitle(getString(R.string.library_version, TaskManager.getVersionName()));
+
         vSwitcher = (ViewSwitcher) findViewById(R.id.switcher);
         list = (ListView) findViewById(android.R.id.list);
 

demo/src/main/java/org/neotech/app/retainabletasksdemo/activity/ProgressTaskHandler.java

@@ -34,17 +34,17 @@ public void execute(){
     }
 
     @TaskAttach(TASK_PROGRESS)
-    public void onAttach(Task task){
+    public void onAttach(SimpleTask task){
         // Task attaches, make sure to show the progress dialog and update the progress if needed.
         progressDialog = ProgressDialog.showIfNotShowing(demoActivityAnnotations.getSupportFragmentManager(), DIALOG_PROGRESS);
         if(task.getLastKnownProgress() != null) {
-            progressDialog.setProgress((Integer) task.getLastKnownProgress());
+            progressDialog.setProgress(task.getLastKnownProgress());
         }
     }
 
     @TaskProgress(TASK_PROGRESS)
-    public void onProgress(Task<?, ?> task, Object progress){
-        progressDialog.setProgress((int) progress);
+    public void onProgress(SimpleTask task){
+        progressDialog.setProgress(task.getLastKnownProgress());
     }
 
     // Now this is cool, we can have a single method handle both the normal onPostExecute and the

demo/src/main/res/values/strings.xml

@@ -32,6 +32,7 @@
 
     <string name="menu_github">View on GitHub</string>
 
+    <string name="library_version">Library version: %1$s</string>
 
     <string name="demo_fragments_title">Fragment TaskManager</string>
     <string name="demo_fragments_description">"<![CDATA[This demonstration shows how individual Fragments use the <code>TaskManager</code> class to start and manage <code>Tasks</code>. Each Fragment extends from the <code>TaskFragmentCompat</code> class, which means that each Fragment has it's own <code>TaskManager</code> instance. <code>Task</code> results are only delivered to the Fragment if it is currently attached to the Activity.]]>"</string>
@@ -45,7 +46,6 @@
     <string name="demo_annotations_title">Annotations example</string>
     <string name="demo_annotations_description">"<![CDATA[This demonstration shows an Activity which extends <code>TaskActivityCompat</code> and uses Annotations to receive <code>Task</code> lifecycle events like <code>onPostExecute</code>.]]>"</string>
 
-
     <string name="demo_serial_title">Serial execution</string>
     <string name="demo_serial_description">"<![CDATA[By default <code>Tasks</code> are executed using a parallel Executor. This demonstration shows how <code>Tasks</code> can be executed in serial using the <code>TaskManager.execute(Task, Callback, Executor)</code> method.]]>"</string>
 

gradle.properties

@@ -18,7 +18,7 @@
 # org.gradle.parallel=true
 
 GROUP=org.neotech.library
-VERSION_NAME=1.0.0-rc-1
+VERSION_NAME=1.0.0-rc-2
 
 BINTRAY_REPO=maven
 BINTRAY_LICENCE=Apache-2.0

library/build.gradle

@@ -11,12 +11,12 @@ group = GROUP
 version = VERSION_NAME
 
 android {
-    compileSdkVersion 25
+    compileSdkVersion 26
     buildToolsVersion '25.0.3'
 
     defaultConfig {
         minSdkVersion 14
-        targetSdkVersion 25
+        targetSdkVersion 26
         versionName = VERSION_NAME
     }
     buildTypes {
@@ -38,12 +38,12 @@ dependencies {
 
     // Android Architecture Lifecycle library to support using the TaskManagerLifeCycleProxy in
     // combination with LifecycleOwner.getLifecycle().addObserver().
-    compile 'android.arch.lifecycle:extensions:1.0.0-alpha3'
-    annotationProcessor "android.arch.lifecycle:compiler:1.0.0-alpha3"
+    compile 'android.arch.lifecycle:extensions:1.0.0-alpha9'
+    annotationProcessor "android.arch.lifecycle:compiler:1.0.0-alpha9"
 
     // Support library for the support library specific TaskManagerOwners (TaskActivityCompat).
-    compile 'com.android.support:appcompat-v7:25.3.1'
-    javadoc 'com.android.support:appcompat-v7:25.3.1'
+    compile 'com.android.support:appcompat-v7:26.0.2'
+    javadoc 'com.android.support:appcompat-v7:26.0.2'
 
     testCompile 'junit:junit:4.12'
 }

library/src/main/java/org/neotech/library/retainabletasks/TaskManager.java

@@ -284,4 +284,12 @@ public static TaskManager getGlobalTaskManager(){
             return globalInstance;
         }
     }
+
+    /**
+     * Returns the version of the library.
+     * @return the version name of the library.
+     */
+    public static String getVersionName(){
+        return BuildConfig.VERSION_NAME;
+    }
 }