├── settings.gradle ├── taskerlibrary ├── src │ ├── main │ │ ├── res │ │ │ └── values │ │ │ │ └── strings.xml │ │ ├── AndroidManifest.xml │ │ └── java │ │ │ └── com │ │ │ └── mastertechsoftware │ │ │ └── tasker │ │ │ ├── Condition.java │ │ │ ├── Pausable.java │ │ │ ├── TaskFinisher.java │ │ │ ├── Task.java │ │ │ ├── Tasks.kt │ │ │ ├── DefaultTask.java │ │ │ └── Tasker.java │ ├── test │ │ └── java │ │ │ └── com │ │ │ └── mastertechsoftware │ │ │ └── tasker │ │ │ └── ExampleUnitTest.java │ └── androidTest │ │ └── java │ │ └── com │ │ └── mastertechsoftware │ │ └── tasker │ │ └── ApplicationTest.java ├── Tasker-tasker.iml ├── proguard-rules.pro ├── build.gradle └── taskerlibrary.iml ├── .idea ├── copyright │ └── profiles_settings.xml ├── encodings.xml ├── vcs.xml ├── libraries │ ├── junit_4_12.xml │ └── hamcrest_core_1_3.xml ├── modules.xml ├── runConfigurations.xml ├── gradle.xml ├── compiler.xml └── misc.xml ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── tasker.iml ├── gradle.properties ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE.txt /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':taskerlibrary' 2 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /.idea/copyright/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kevindmoore/tasker/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .classpath 3 | .project 4 | .settings/ 5 | .gradle/ 6 | build/ 7 | local.properties 8 | backup/ 9 | bin/ 10 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/Condition.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | /** 4 | * Interface for signaling the execution of the task 5 | */ 6 | public interface Condition { 7 | boolean shouldExecute(); 8 | } 9 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/Pausable.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | /** 4 | * Interface for classes that set/get pause flag 5 | */ 6 | public interface Pausable { 7 | boolean isPaused(); 8 | void setPaused(boolean paused); 9 | } 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Thu Jul 13 20:07:47 PDT 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-milestone-1-all.zip 7 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/TaskFinisher.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | import java.util.List; 4 | 5 | /** 6 | * Implement this interface when all tasks have finished 7 | */ 8 | public interface TaskFinisher { 9 | void finished(List errors); 10 | } 11 | -------------------------------------------------------------------------------- /taskerlibrary/src/test/java/com/mastertechsoftware/tasker/ExampleUnitTest.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | import org.junit.Test; 4 | 5 | import static org.junit.Assert.*; 6 | 7 | /** 8 | * To work on unit tests, switch the Test Artifact in the Build Variants view. 9 | */ 10 | public class ExampleUnitTest { 11 | @Test 12 | public void addition_isCorrect() throws Exception { 13 | assertEquals(4, 2 + 2); 14 | } 15 | } -------------------------------------------------------------------------------- /taskerlibrary/src/androidTest/java/com/mastertechsoftware/tasker/ApplicationTest.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | import android.app.Application; 4 | import android.test.ApplicationTestCase; 5 | 6 | /** 7 | * Testing Fundamentals 8 | */ 9 | public class ApplicationTest extends ApplicationTestCase { 10 | public ApplicationTest() { 11 | super(Application.class); 12 | } 13 | } -------------------------------------------------------------------------------- /taskerlibrary/Tasker-tasker.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/libraries/junit_4_12.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /.idea/libraries/hamcrest_core_1_3.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 12 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/Task.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | /** 4 | * All tasks need to implement this interface 5 | */ 6 | public interface Task { 7 | Object run(); 8 | boolean shouldContinue(); 9 | boolean hasError(); 10 | Exception getError(); 11 | void setError(Exception error); 12 | void setResult(T result); 13 | T getResult(); 14 | void setPreviousResult(T result); 15 | T getPreviousResult(); 16 | void setPauseable(Pausable pauseable); 17 | void setCondition(Condition condition); 18 | Condition getCondition(); 19 | boolean hasCondition(); 20 | Tasker.THREAD_TYPE runType(); 21 | void setRunType(Tasker.THREAD_TYPE type); 22 | } 23 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 17 | 18 | -------------------------------------------------------------------------------- /taskerlibrary/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # By default, the flags in this file are appended to flags specified 3 | # in /Users/Kevin/Java/android/tools/proguard/proguard-android.txt 4 | # You can edit the include path and order by changing the proguardFiles 5 | # directive in build.gradle. 6 | # 7 | # For more details, see 8 | # http://developer.android.com/guide/developing/tools/proguard.html 9 | 10 | # Add any project specific keep options here: 11 | 12 | # If your project uses WebView with JS, uncomment the following 13 | # and specify the fully qualified class name to the JavaScript interface 14 | # class: 15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 16 | # public *; 17 | #} 18 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 22 | -------------------------------------------------------------------------------- /tasker.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | 3 | # IDE (e.g. Android Studio) users: 4 | # Gradle settings configured through the IDE *will override* 5 | # any settings specified in this file. 6 | 7 | # For more details on how to configure your build environment visit 8 | # http://www.gradle.org/docs/current/userguide/build_environment.html 9 | 10 | # Specifies the JVM arguments used for the daemon process. 11 | # The setting is particularly useful for tweaking memory settings. 12 | # Default value: -Xmx10248m -XX:MaxPermSize=256m 13 | # org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 14 | 15 | # When configured, Gradle will run in incubating parallel mode. 16 | # This option should only be used with decoupled projects. More details, visit 17 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 18 | # org.gradle.parallel=true 19 | org.gradle.daemon=true 20 | org.gradle.parallel=true 21 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/Tasks.kt: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker 2 | 3 | /** 4 | * Kotlin helper functions 5 | */ 6 | class KotlinTask(var runFunc : ((task: KotlinTask) -> Any?)) : DefaultTask() { 7 | 8 | override fun run(): Any? { 9 | return runFunc(this) 10 | } 11 | } 12 | 13 | class KotlinCondition(val condFun : () -> Boolean) : Condition { 14 | override fun shouldExecute(): Boolean { 15 | return condFun() 16 | } 17 | 18 | } 19 | /** 20 | * Extension to pass in a function instead of an object 21 | */ 22 | fun Tasker.addTask(runFunc: (task: KotlinTask) -> Any?) : Tasker { 23 | this.addTask(KotlinTask(runFunc)) 24 | return this 25 | } 26 | 27 | 28 | fun Tasker.addUITask(runFunc: (task: KotlinTask) -> Any?) : Tasker { 29 | this.addUITask(KotlinTask(runFunc)) 30 | return this 31 | } 32 | 33 | fun Tasker.withCondition(condFun: () -> Boolean) : Tasker { 34 | this.withCondition(KotlinCondition(condFun)) 35 | return this 36 | } -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 12 | 13 | 14 | 26 | 36 | 37 | 38 | 39 | 40 | 41 | 43 | 44 | 45 | 46 | 47 | 1.8 48 | 49 | 54 | 55 | 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/DefaultTask.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | /** 4 | * Abstract class. Implements everything except run 5 | */ 6 | public abstract class DefaultTask implements Task { 7 | protected Tasker.THREAD_TYPE threadType = Tasker.THREAD_TYPE.BACKGROUND; 8 | 9 | protected boolean shouldContinue = true; 10 | protected Pausable pauseable; 11 | protected Exception error; 12 | protected Condition condition; 13 | protected T result; 14 | protected T previousTaskResult; 15 | 16 | /** 17 | * Constructors 18 | */ 19 | public DefaultTask() { 20 | } 21 | 22 | public DefaultTask(Tasker.THREAD_TYPE threadType) { 23 | this.threadType = threadType; 24 | } 25 | 26 | /** 27 | * Set the class that implements the Pausable interface - Want to be able 28 | * to pause the class that is running this task 29 | * @param pauseable 30 | */ 31 | @Override 32 | public void setPauseable(Pausable pauseable) { 33 | this.pauseable = pauseable; 34 | } 35 | 36 | /** 37 | * Pause this task. Once other conditions are finished, unpause 38 | * @param paused 39 | */ 40 | public void setPaused(boolean paused) { 41 | if (pauseable != null) { 42 | pauseable.setPaused(paused); 43 | } 44 | } 45 | 46 | /** 47 | * Get/Set Error 48 | */ 49 | @Override 50 | public Exception getError() { 51 | return error; 52 | } 53 | 54 | @Override 55 | public boolean hasError() { 56 | return error != null; 57 | } 58 | 59 | @Override 60 | public void setError(Exception error) { 61 | this.error = error; 62 | } 63 | 64 | /** 65 | * Set a condition that will be executed before running the task 66 | * If the condition returns false, the task won't be run 67 | * @param condition 68 | */ 69 | @Override 70 | public void setCondition(Condition condition) { 71 | this.condition = condition; 72 | } 73 | 74 | @Override 75 | public Condition getCondition() { 76 | return condition; 77 | } 78 | 79 | @Override 80 | public boolean hasCondition() { 81 | return condition != null; 82 | } 83 | 84 | /** 85 | * Get/Set Results 86 | * @param result 87 | */ 88 | @Override 89 | public void setResult(T result) { 90 | this.result = result; 91 | } 92 | 93 | @Override 94 | public T getResult() { 95 | return result; 96 | } 97 | 98 | /** 99 | * Set/Get the previous result 100 | * @return 101 | */ 102 | @Override 103 | public T getPreviousResult() { 104 | return previousTaskResult; 105 | } 106 | 107 | @Override 108 | public void setPreviousResult(T result) { 109 | previousTaskResult = result; 110 | } 111 | 112 | /** 113 | * If this flag it set to false, the following tasks will not be run 114 | * @return true runs the rest of the tasks 115 | */ 116 | @Override 117 | public boolean shouldContinue() { 118 | return shouldContinue; 119 | } 120 | 121 | public void setShouldContinue(boolean shouldContinue) { 122 | this.shouldContinue = shouldContinue; 123 | } 124 | 125 | /** 126 | * Run type: UI or background 127 | */ 128 | @Override 129 | public Tasker.THREAD_TYPE runType() { 130 | return threadType; 131 | } 132 | 133 | @Override 134 | public void setRunType(Tasker.THREAD_TYPE threadType) { 135 | this.threadType = threadType; 136 | } 137 | 138 | /** 139 | * All subclasses must implement this method. 140 | * Run any task code here. 141 | * @return result 142 | */ 143 | @Override 144 | public abstract Object run(); 145 | } 146 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Tasker 2 | This library helps with sequential tasks that will be run one after another and only when each task is finished. These tasks can either be UI or background. 3 | 4 | ## Downloading 5 | ``` 6 | Gradle 7 | compile 'com.mastertechsoftware.tasker:taskerlibrary:1.0.9' 8 | ``` 9 | 10 | ## Android Java Example 11 | 12 | ``` 13 | Tasker.create(). 14 | // Check for google Play services 15 | addUITask(new DefaultTask() { 16 | @Override 17 | public Object run() { 18 | acquireGooglePlayServices(); 19 | return null; 20 | } 21 | }) 22 | .withCondition(new Condition() { 23 | @Override 24 | public boolean shouldExecute() { 25 | return !isGooglePlayServicesAvailable(); 26 | } 27 | }) 28 | // Check to see if we have permissions 29 | .addUITask(new DefaultTask() { 30 | 31 | @Override 32 | public Object run() { 33 | String accountName = getPreferences(Context.MODE_PRIVATE) 34 | .getString(PREF_ACCOUNT_NAME, null); 35 | if (accountName != null) { 36 | mCredential.setSelectedAccountName(accountName); 37 | } else { 38 | startAccountChooser(); 39 | currentDefaultTaskHandler = this; 40 | setPaused(true); 41 | } 42 | return null; 43 | } 44 | }) 45 | .withCondition(new Condition() { 46 | @Override 47 | public boolean shouldExecute() { 48 | return EasyPermissions.hasPermissions( 49 | MainActivity.this, Manifest.permission.GET_ACCOUNTS); 50 | } 51 | }) 52 | .addTask(new DefaultTask() { 53 | @Override 54 | public Object run() { 55 | signIn(); 56 | setShouldContinue(false); 57 | return null; 58 | } 59 | }) 60 | .addFinisher(new TaskFinisher() { 61 | @Override 62 | void finished(List errors) { 63 | Logger.debug("Finished"); 64 | 65 | } 66 | }) 67 | .run(); 68 | 69 | @Override 70 | protected void onActivityResult( 71 | int requestCode, int resultCode, Intent data) { 72 | super.onActivityResult(requestCode, resultCode, data); 73 | switch(requestCode) { 74 | case REQUEST_GOOGLE_PLAY_SERVICES: 75 | if (resultCode == RESULT_OK) { 76 | if (currentDefaultTaskHandler != null) { 77 | currentDefaultTaskHandler.setPaused(false); 78 | currentDefaultTaskHandler = null; 79 | } 80 | } 81 | } 82 | } 83 | 84 | ``` 85 | ##Kotlin Example 86 | ``` 87 | Tasker.create() 88 | .addTask { 89 | // Background Task 90 | } 91 | .addUITask{ task -> 92 | // UI Task 93 | } 94 | .run() 95 | ``` 96 | ## Important Concepts 97 | To start, just use Tasker.create(). This is in the builder format where calls can be chained together. 98 | 99 | To run a UI Task call addUITask(Task). A DefaultTask class is provided so you can just override the run method. To add a background task call addTask. All tasks run in order so that even with background tasks, the next task won't run until that one is done. 100 | 101 | ### Conditions 102 | If you want a task to only run when a certain condition is met, add a Condition class in withCondition. This will return true to run or false to skip. 103 | 104 | ### Stopping/Pausing 105 | To stop processing, just call setShouldContinue(false); 106 | 107 | To pause a UI Task to wait for user input, call setPaused(true). When ready, call setPaused(false). In our example, I have a variable named currentDefaultTaskHandler that I set so the rest of the code knows which task to unpause. 108 | 109 | To handle things when all tasks are done (either with a successful or error state), add a TaskFinisher to the end. (actually it can be anywhere) 110 | ### Possible Issues 111 | The second task runs right after the first: This may happen if your first task which is run on a background thread calls another API that also runs in the background. In this case you need to tell the task to pause until the API returns. 112 | 113 | ``` 114 | Tasker.create().addTask { Task -> 115 | task.setPaused(true) 116 | ApiCall.doSomeLongRunningTask( object: callback { 117 | override fun callbackmethod() { 118 | task.setPaused(false) 119 | } 120 | }) 121 | .addUITask { 122 | } 123 | .withCondition { 124 | 125 | } 126 | .run() 127 | ``` 128 | 129 | ## License 130 | Copyright 2016 Master Tech Software. 131 | 132 | Licensed under the Apache License, Version 2.0 (the "License"); 133 | you may not use this file except in compliance with the License. 134 | You may obtain a copy of the License at 135 | 136 | http://www.apache.org/licenses/LICENSE-2.0 137 | 138 | Unless required by applicable law or agreed to in writing, software 139 | distributed under the License is distributed on an "AS IS" BASIS, 140 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 141 | See the License for the specific language governing permissions and 142 | limitations under the License. -------------------------------------------------------------------------------- /taskerlibrary/build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | buildscript { 3 | apply from: '../../tools.gradle' 4 | repositories { 5 | jcenter() 6 | maven { 7 | url 'https://maven.google.com' 8 | } 9 | } 10 | dependencies { 11 | classpath "com.android.tools.build:gradle:$gradle_build_version" 12 | classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:$gradle_bintray_version" 13 | classpath "com.github.dcendents:android-maven-gradle-plugin:$gradle_maven_version" 14 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_plugin_version" 15 | } 16 | } 17 | */ 18 | //apply from: '../../projects.gradle' 19 | 20 | apply plugin: 'com.android.library' 21 | apply plugin: 'kotlin-android' 22 | apply plugin: 'com.github.dcendents.android-maven' 23 | apply plugin: 'com.jfrog.bintray' 24 | 25 | ext { 26 | github = 'https://github.com/kevindmoore/tasker' 27 | githubUrl = 'https://github.com/kevindmoore/tasker.git' 28 | projName = 'taskerlibrary' 29 | projDescription = 'Library for UI and background tasks' 30 | currentVersionCode = 9 31 | currentVersion = '1.0.9' 32 | groupId = 'com.mastertechsoftware.tasker' 33 | buildPath = 'com/mastertechsoftware/tasker/taskerlibrary/' + currentVersion 34 | } 35 | 36 | repositories { 37 | maven { 38 | url "https://dl.bintray.com/kevindmoore/tasker" 39 | } 40 | } 41 | 42 | android { 43 | compileSdkVersion androidCompileSdkVersion 44 | buildToolsVersion androidBuildToolsVersion 45 | 46 | defaultConfig { 47 | minSdkVersion androidMinSdkVersion 48 | targetSdkVersion androidTargetSdkVersion 49 | versionCode currentVersionCode 50 | versionName currentVersion 51 | } 52 | buildTypes { 53 | release { 54 | minifyEnabled false 55 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 56 | } 57 | } 58 | } 59 | 60 | dependencies { 61 | implementation fileTree(dir: 'libs', include: ['*.jar']) 62 | testImplementation 'junit:junit:4.12' 63 | implementation libLogging 64 | // compile project(':logging') 65 | implementation libKotlin 66 | } 67 | 68 | task generateSourcesJar(type: Jar) { 69 | from android.sourceSets.main.java.srcDirs 70 | classifier 'sources' 71 | } 72 | 73 | 74 | task generateJavadocs(type: Javadoc) { 75 | excludes = ['**/*.kt'] 76 | source = android.sourceSets.main.java.srcDirs 77 | classpath += project.files(android.getBootClasspath() 78 | .join(File.pathSeparator)) 79 | classpath += project.files(configurations.compile) 80 | failOnError false 81 | } 82 | 83 | 84 | task generateJavadocsJar(type: Jar) { 85 | from generateJavadocs.destinationDir 86 | classifier 'javadoc' 87 | } 88 | 89 | generateJavadocsJar.dependsOn generateJavadocs 90 | 91 | 92 | artifacts { 93 | archives generateJavadocsJar 94 | archives generateSourcesJar 95 | } 96 | 97 | 98 | install { 99 | repositories.mavenInstaller { 100 | 101 | pom.project { 102 | name projName 103 | description projDescription 104 | url github 105 | inceptionYear '2016' 106 | 107 | packaging 'aar' 108 | groupId groupId 109 | artifactId projName 110 | version currentVersion 111 | 112 | licenses { 113 | license { 114 | name 'The Apache Software License, Version 2.0' 115 | url 'http://www.apache.org/licenses/LICENSE-2.0.txt' 116 | distribution 'repo' 117 | } 118 | } 119 | scm { 120 | connection githubUrl 121 | url github 122 | 123 | } 124 | developers { 125 | developer { 126 | name 'Kevin Moore' 127 | } 128 | } 129 | } 130 | } 131 | } 132 | 133 | group = groupId 134 | version = currentVersion 135 | 136 | 137 | bintray { 138 | user = bintray_user 139 | key = bintray_key 140 | filesSpec { 141 | from ('build/libs') { 142 | include '*.jar' 143 | rename ("tasker-" + currentVersion + "-(.*)\\.jar", projName + '-' + currentVersion + "-\$1.jar") 144 | } 145 | into buildPath 146 | from ('build/outputs/aar') { 147 | include 'tasker-release.aar' 148 | rename {projName + '-' + currentVersion + ".aar"} 149 | } 150 | into buildPath 151 | from ('build/poms') { 152 | include '*.xml' 153 | rename {projName + '-' + currentVersion + ".pom"} 154 | } 155 | into buildPath 156 | } 157 | // dryRun = false //Whether to run this as dry-run, without deploying 158 | // configurations = ['archives'] 159 | // override = true 160 | pkg { 161 | repo = 'maven' 162 | name = projName 163 | 164 | labels = ['android'] 165 | licenses = ['Apache-2.0'] 166 | vcsUrl = githubUrl 167 | websiteUrl = github 168 | // version { 169 | // name = currentVersion 170 | // desc = projDescription 171 | // released = new Date() 172 | // vcsTag = currentVersion 173 | // } 174 | } 175 | } 176 | 177 | //bintray.dependsOn install 178 | //install.dependsOn assemble 179 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # Attempt to set APP_HOME 46 | # Resolve links: $0 may be a link 47 | PRG="$0" 48 | # Need this for relative symlinks. 49 | while [ -h "$PRG" ] ; do 50 | ls=`ls -ld "$PRG"` 51 | link=`expr "$ls" : '.*-> \(.*\)$'` 52 | if expr "$link" : '/.*' > /dev/null; then 53 | PRG="$link" 54 | else 55 | PRG=`dirname "$PRG"`"/$link" 56 | fi 57 | done 58 | SAVED="`pwd`" 59 | cd "`dirname \"$PRG\"`/" >/dev/null 60 | APP_HOME="`pwd -P`" 61 | cd "$SAVED" >/dev/null 62 | 63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 64 | 65 | # Determine the Java command to use to start the JVM. 66 | if [ -n "$JAVA_HOME" ] ; then 67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 68 | # IBM's JDK on AIX uses strange locations for the executables 69 | JAVACMD="$JAVA_HOME/jre/sh/java" 70 | else 71 | JAVACMD="$JAVA_HOME/bin/java" 72 | fi 73 | if [ ! -x "$JAVACMD" ] ; then 74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 75 | 76 | Please set the JAVA_HOME variable in your environment to match the 77 | location of your Java installation." 78 | fi 79 | else 80 | JAVACMD="java" 81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 82 | 83 | Please set the JAVA_HOME variable in your environment to match the 84 | location of your Java installation." 85 | fi 86 | 87 | # Increase the maximum file descriptors if we can. 88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 89 | MAX_FD_LIMIT=`ulimit -H -n` 90 | if [ $? -eq 0 ] ; then 91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 92 | MAX_FD="$MAX_FD_LIMIT" 93 | fi 94 | ulimit -n $MAX_FD 95 | if [ $? -ne 0 ] ; then 96 | warn "Could not set maximum file descriptor limit: $MAX_FD" 97 | fi 98 | else 99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 100 | fi 101 | fi 102 | 103 | # For Darwin, add options to specify how the application appears in the dock 104 | if $darwin; then 105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 106 | fi 107 | 108 | # For Cygwin, switch paths to Windows format before running java 109 | if $cygwin ; then 110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 112 | JAVACMD=`cygpath --unix "$JAVACMD"` 113 | 114 | # We build the pattern for arguments to be converted via cygpath 115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 116 | SEP="" 117 | for dir in $ROOTDIRSRAW ; do 118 | ROOTDIRS="$ROOTDIRS$SEP$dir" 119 | SEP="|" 120 | done 121 | OURCYGPATTERN="(^($ROOTDIRS))" 122 | # Add a user-defined pattern to the cygpath arguments 123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 125 | fi 126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 127 | i=0 128 | for arg in "$@" ; do 129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 131 | 132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 134 | else 135 | eval `echo args$i`="\"$arg\"" 136 | fi 137 | i=$((i+1)) 138 | done 139 | case $i in 140 | (0) set -- ;; 141 | (1) set -- "$args0" ;; 142 | (2) set -- "$args0" "$args1" ;; 143 | (3) set -- "$args0" "$args1" "$args2" ;; 144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 150 | esac 151 | fi 152 | 153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 154 | function splitJvmOpts() { 155 | JVM_OPTS=("$@") 156 | } 157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 159 | 160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 161 | -------------------------------------------------------------------------------- /taskerlibrary/taskerlibrary.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | 11 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /taskerlibrary/src/main/java/com/mastertechsoftware/tasker/Tasker.java: -------------------------------------------------------------------------------- 1 | package com.mastertechsoftware.tasker; 2 | 3 | 4 | import com.mastertechsoftware.logging.Logger; 5 | 6 | import android.os.Handler; 7 | import android.os.Looper; 8 | 9 | import java.util.ArrayList; 10 | import java.util.List; 11 | import java.util.Map; 12 | import java.util.concurrent.Callable; 13 | import java.util.concurrent.ConcurrentHashMap; 14 | import java.util.concurrent.CountDownLatch; 15 | import java.util.concurrent.ExecutorService; 16 | import java.util.concurrent.Executors; 17 | import java.util.concurrent.Future; 18 | import java.util.concurrent.LinkedBlockingDeque; 19 | import java.util.concurrent.TimeUnit; 20 | 21 | /** 22 | * Class for Sequentially running tasks in the background 23 | */ 24 | public class Tasker { 25 | public enum THREAD_TYPE { 26 | UI, 27 | BACKGROUND 28 | } 29 | 30 | private static final String TAG = Tasker.class.getSimpleName(); 31 | protected Handler handler; 32 | protected ExecutorService mExecutor = Executors.newSingleThreadExecutor(); 33 | protected LinkedBlockingDeque tasks = new LinkedBlockingDeque<>(); 34 | protected TaskFinisher finisher; 35 | protected boolean debugging = false; 36 | protected Task lastAddedTask; 37 | protected Map runableMap = new ConcurrentHashMap<>(); 38 | protected List errors = new ArrayList<>(); 39 | protected Object previousResult; 40 | 41 | /** 42 | * Simple create task to get us started 43 | * @return Tasker 44 | */ 45 | static public Tasker create() { 46 | return new Tasker(); 47 | } 48 | 49 | 50 | /** 51 | * Add a new task 52 | * @param task 53 | * @return Tasker 54 | */ 55 | public Tasker addTask(Task task) { 56 | tasks.add(task); 57 | lastAddedTask = task; 58 | return this; 59 | } 60 | 61 | /** 62 | * Create the handler as late as possible to make sure the main thread is ready 63 | */ 64 | protected void createHandler() { 65 | if (handler != null) return; 66 | try { 67 | handler = new Handler(Looper.getMainLooper()); 68 | } catch (RuntimeException e) { 69 | 70 | } 71 | } 72 | 73 | /** 74 | * Add a new UI task 75 | * @param task 76 | * @return Tasker 77 | */ 78 | public Tasker addUITask(Task task) { 79 | tasks.add(task); 80 | task.setRunType(THREAD_TYPE.UI); 81 | lastAddedTask = task; 82 | return this; 83 | } 84 | 85 | /** 86 | * Add a class that will handle the final ending moment 87 | * @param finisher 88 | * @return Tasker 89 | */ 90 | public Tasker addFinisher(TaskFinisher finisher) { 91 | this.finisher = finisher; 92 | return this; 93 | } 94 | 95 | /** 96 | * Add a condition to the last added task. 97 | * Task will only be run if this task is true 98 | * @param condition 99 | * @return Tasker 100 | */ 101 | public Tasker withCondition(Condition condition) { 102 | lastAddedTask.setCondition(condition); // Note: This will crash if you haven't added at least 1 task 103 | return this; 104 | } 105 | 106 | /** 107 | * Cancel all running tasks 108 | */ 109 | public void cancelAll() { 110 | for (Future future : runableMap.values()) { 111 | future.cancel(true); 112 | } 113 | runableMap.clear(); 114 | shutdown(); 115 | } 116 | 117 | /** 118 | * Shutdown the executor 119 | */ 120 | private void shutdown() { 121 | if (!mExecutor.isShutdown() && !mExecutor.isTerminated()) { 122 | mExecutor.shutdown(); 123 | try { 124 | mExecutor.awaitTermination(2, TimeUnit.MINUTES); 125 | } catch (InterruptedException e) { 126 | Logger.error("Problems awaiting Executor shutdown"); 127 | } 128 | } 129 | } 130 | 131 | /** 132 | * Cancel a single task 133 | * @param task 134 | * @return true if we found and cancelled the task 135 | */ 136 | public boolean cancelTask(Task task) { 137 | for (ThreadRunnable threadRunnable : runableMap.keySet()) { 138 | if (threadRunnable.task == task) { 139 | Future future = runableMap.remove(threadRunnable); 140 | if (future != null) { 141 | future.cancel(true); 142 | } 143 | return true; 144 | } 145 | } 146 | return false; 147 | } 148 | 149 | /** 150 | * Start running all tasks 151 | * @return true if everything started ok 152 | */ 153 | public boolean run() { 154 | // Wrap the whole thing so we can make sure to unlock in 155 | // case something throws. 156 | try { 157 | 158 | for (Task task : tasks) { 159 | final ThreadRunnable threadRunnable = new ThreadRunnable(task); 160 | recreateExecutorIfNecessary(); 161 | final Future future = mExecutor.submit(threadRunnable); 162 | runableMap.put(threadRunnable, future); 163 | } 164 | 165 | tasks.clear(); 166 | 167 | } catch (Exception RejectedExecutionException) { 168 | Logger.error("Tasker:run - RejectedExecutionException", RejectedExecutionException); 169 | return false; 170 | } 171 | return true; 172 | } 173 | 174 | private void recreateExecutorIfNecessary() { 175 | // If we're shutdown or terminated we can't accept any new requests. 176 | if (mExecutor == null || mExecutor.isShutdown() || mExecutor.isTerminated()) { 177 | if (mExecutor != null) { 178 | Logger.error("Tasker:run - Executor is shutdown. Recreating"); 179 | } 180 | mExecutor = Executors.newSingleThreadExecutor(); 181 | } 182 | } 183 | 184 | /** 185 | * Remove the runnable from our map and call the finisher if it's the last one 186 | * @param threadRunnable 187 | */ 188 | protected void runnableFinished(ThreadRunnable threadRunnable) { 189 | Logger.debug(debugging,"runnableFinished"); 190 | runableMap.remove(threadRunnable); 191 | final Task task = threadRunnable.getTask(); 192 | previousResult = task.getResult(); 193 | if (runableMap.isEmpty() && finisher != null) { 194 | createHandler(); 195 | Logger.debug(debugging,"Calling finisher"); 196 | handler.post(new Runnable() { 197 | @Override 198 | public void run() { 199 | finisher.finished(errors); 200 | } 201 | }); 202 | } 203 | 204 | // If we have no more tasks, then shutdown the executor 205 | if (runableMap.isEmpty()) { 206 | shutdown(); 207 | } 208 | } 209 | 210 | 211 | /** 212 | * Runnable that uses our callback and then runs the result on UI thread 213 | * or background thread (which is what it is on) 214 | */ 215 | class ThreadRunnable implements Callable, Pausable { 216 | protected Task task; 217 | protected Object result; 218 | protected CountDownLatch uiWait = new CountDownLatch(1); 219 | protected CountDownLatch pauseWait = new CountDownLatch(1); 220 | protected boolean paused = false; 221 | 222 | ThreadRunnable(Task task) { 223 | this.task = task; 224 | task.setPauseable(this); 225 | } 226 | 227 | public Task getTask() { 228 | return task; 229 | } 230 | 231 | @Override 232 | public Object call() throws Exception { 233 | try { 234 | if (task.hasCondition() && !task.getCondition().shouldExecute()) { 235 | Logger.debug(debugging,"Tasks condition failed. Not running task"); 236 | runnableFinished(this); 237 | return null; 238 | } 239 | 240 | createHandler(); 241 | 242 | if (previousResult != null) { 243 | task.setPreviousResult(previousResult); 244 | previousResult = null; 245 | } 246 | if (task.runType() == THREAD_TYPE.BACKGROUND) { 247 | Logger.debug(debugging, "Running task in background"); 248 | result = task.run(); 249 | task.setResult(result); 250 | } else { 251 | // Make UI Thread calls 252 | handler.post(new Runnable() { 253 | @Override 254 | public void run() { 255 | try { 256 | Logger.debug(debugging,"Running task on UI Thread"); 257 | result = task.run(); 258 | task.setResult(result); 259 | uiWait.countDown(); 260 | } catch (Exception e) { 261 | task.setError(e); 262 | if (task.runType() == THREAD_TYPE.UI) { 263 | uiWait.countDown(); 264 | } 265 | } 266 | } 267 | }); 268 | // Wait until UI is finished 269 | uiWait.await(); 270 | } 271 | if (paused) { 272 | pauseWait.await(); 273 | } 274 | runnableFinished(this); 275 | if (!task.shouldContinue()) { 276 | cancelAll(); 277 | } 278 | return result; 279 | } catch (final Exception e) { 280 | Logger.error("run caught exception", e); 281 | handler.post(new Runnable() { 282 | @Override 283 | public void run() { 284 | try { 285 | errors.add(e); 286 | task.setError(e); 287 | } catch (Exception e2) { 288 | Logger.error("run caught exception in setError", e2); 289 | } 290 | } 291 | }); 292 | } 293 | runnableFinished(this); 294 | return null; 295 | } 296 | 297 | @Override 298 | public boolean isPaused() { 299 | return paused; 300 | } 301 | 302 | @Override 303 | public void setPaused(boolean paused) { 304 | this.paused = paused; 305 | if (!paused) { 306 | pauseWait.countDown(); 307 | } 308 | } 309 | 310 | @Override 311 | public boolean equals(Object o) { 312 | if (this == o) return true; 313 | if (o == null || getClass() != o.getClass()) return false; 314 | 315 | ThreadRunnable that = (ThreadRunnable) o; 316 | 317 | return task != null ? task.equals(that.task) : that.task == null; 318 | 319 | } 320 | 321 | @Override 322 | public int hashCode() { 323 | return task != null ? task.hashCode() : 0; 324 | } 325 | 326 | } 327 | } 328 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------