├── .gitignore ├── README.md ├── LICENSE └── Promise.java /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.ap_ 4 | 5 | # Files for the ART/Dalvik VM 6 | *.dex 7 | 8 | # Java class files 9 | *.class 10 | 11 | # Generated files 12 | bin/ 13 | gen/ 14 | out/ 15 | 16 | # Gradle files 17 | .gradle/ 18 | build/ 19 | 20 | # Local configuration file (sdk path, etc) 21 | local.properties 22 | 23 | # Proguard folder generated by Eclipse 24 | proguard/ 25 | 26 | # Log Files 27 | *.log 28 | 29 | # Android Studio Navigation editor temp files 30 | .navigation/ 31 | 32 | # Android Studio captures folder 33 | captures/ 34 | 35 | # Intellij 36 | *.iml 37 | .idea/workspace.xml 38 | .idea/tasks.xml 39 | .idea/gradle.xml 40 | .idea/dictionaries 41 | .idea/libraries 42 | 43 | # Keystore files 44 | *.jks 45 | 46 | # External native build folder generated in Android Studio 2.2 and later 47 | .externalNativeBuild 48 | 49 | # Google Services (e.g. APIs or Firebase) 50 | google-services.json 51 | 52 | # Freeline 53 | freeline.py 54 | freeline/ 55 | freeline_project_description.json 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # android-promise : 2 | 3 | A Javascript style JAVA Promise library for Android JVM. 4 | 5 | * Simply copy the Promise.java and past in your source foulder, it will work. 6 | 7 | ```java 8 | promiseObject 9 | .then() 10 | .then() 11 | .then() // Do task one after another 'n' number of chain 12 | .error(); 13 | ``` 14 | 15 | 16 | ### How it works ? 17 | 18 | ```java 19 | doSomeTask(int someValue, String extra) 20 | .then(res -> doSecondTask((MyObject) res)) // res is result form doSomeTask() 21 | .then(res -> doThirdTask((OtherObject) res))) // res is result form doThirdTask() 22 | .then(res -> doFourthTask((int) res))) // res is result form doThirdTask() 23 | .then(res -> doFivethTask()) 24 | .then(res -> { 25 | // Consume result of the previous function 26 | return true; // done 27 | }) 28 | .error(err -> handleError()); // Incase of any p.reject() call from above function error will be available here 29 | ``` 30 | 31 | ```java 32 | public Promise doSomeTask(int someValue, String extra){ 33 | Promise p = new Promise(); 34 | new Thread(()->{ 35 | // do some background operation. 36 | // When your work done, resolve the promise like below; 37 | // After resolve the library will pass the value to doSecondTack() 38 | // Suppose your resultant value is instance of MyObject, then 39 | // When it is error call reject() with some error message or an Exception 40 | // p.reject("Some Error happened") 41 | 42 | MyObject myObject = new MyObject(); 43 | p.resolve(myObject); 44 | }); 45 | return p; 46 | } 47 | 48 | public OtherObject doSecondTask(MyObject myInput) { 49 | // Do some syncronous or asyncronous task and return the result, 50 | // Still it work with your promise chain. 51 | // Folloing snipet is just a sample work flow 52 | 53 | OtherObject obj = new OtherObject(); 54 | 55 | return obj; 56 | } 57 | 58 | 59 | public Promise doThirdTask(OtherObject otherObject){ 60 | // Do some task, return value using promise 61 | Promise p = new Promise(); 62 | 63 | // Your task 64 | 65 | p.resolve(); 66 | 67 | return p; 68 | } 69 | 70 | public Promise doFourthTask(){ 71 | return doSomePromisableTask(); // I am not writing defination of this fuction, let this function is very similar to 72 | // `doSomeTask()` function 73 | } 74 | 75 | public Promise doFivethTask(){ 76 | return doSomePromisableTask() 77 | .then(res -> { 78 | // Do some task here 79 | return 1; // this one will be available in the next the or parent then which called this task 80 | }); 81 | } 82 | ``` 83 | 84 | ### How to use in android? 85 | 86 | *__Download the source file__ add into your project src.* 87 | 88 | __Promise.java__ Simply Copy this file into your project 89 | 90 | __*It need JAVA 1.8 to compile__ 91 | 92 | 93 | ## Description 94 | 95 | The Promise object represents the eventual completion (or failure) 96 | of an asynchronous operation, and its resulting value. 97 |
98 | A Promise is a proxy for a value not necessarily known when 99 | the promise is created. It allows you to associate handlers 100 | with an asynchronous action's eventual success value or failure reason. 101 | This lets asynchronous methods return values like synchronous methods: 102 | instead of immediately returning the final value, 103 | the asynchronous method returns a promise to supply the value 104 | at some point in the future. 105 |
106 | For more information on Javascript Promise 107 | please visit the official Mozilla Promise documentation 108 | 109 | @see 110 | https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise 111 |
112 | This Android Promise Library slightly different than the native Javascript Promise. 113 | This promise object has two imprtant method i.e. `resolve()` and `reject()`, 114 | whenevey you done withe your process just call resolve or reject 115 | function based on your state. 116 | The resultant value will be automaticall passed as argument to the 117 | followng `then()` or `error()` function. 118 |
119 | You can write `n` numbers of `then()` chain. 120 |
121 | It supports above JAVA 1.8 122 | 123 | 124 | # LICENCE 125 | 126 | 127 | Copyright (c) 2017 CRAWLINK NETWORKS PVT. LTD. 128 | 129 | Licensed under the Apache License, Version 2.0 (the "License"); 130 | you may not use this file except in compliance with the License. 131 | You may obtain a copy of the License at 132 | 133 | http://www.apache.org/licenses/LICENSE-2.0 134 | 135 | Unless required by applicable law or agreed to in writing, software 136 | distributed under the License is distributed on an "AS IS" BASIS, 137 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 138 | See the License for the specific language governing permissions and 139 | limitations under the License. 140 | 141 | 142 | 143 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [2017] [CRAWLINK NETWORKS PVT. LTD.] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Promise.java: -------------------------------------------------------------------------------- 1 | /* 2 | * CRAWLINK Networks Pvt Ltd. CONFIDENTIAL 3 | * Copyright (c) 2017 All rights reserved. 4 | * 5 | * The source code contained or described herein and all documents 6 | * related to the source code ("Material") are owned by CRAWLINK 7 | * Networks Pvt Ltd. No part of the Material may be used, copied, 8 | * reproduced, modified, published, uploaded,posted, transmitted, 9 | * distributed, or disclosed in any way without CRAWLINK Networks 10 | * Pvt Ltd. prior written permission. 11 | * 12 | * No license under any patent, copyright, trade secret or other 13 | * intellectual property right is granted to or conferred upon you 14 | * by disclosure or delivery of the Materials, either expressly, by 15 | * implication, inducement, estoppel or otherwise. Any license 16 | * under such intellectual property rights must be express and 17 | * approved by CRAWLINK Networks Pvt Ltd. in writing. 18 | * 19 | */ 20 | 21 | package com.crawlink; 22 | 23 | 24 | import android.os.Handler; 25 | import android.os.Looper; 26 | import android.util.Log; 27 | 28 | import java.util.ArrayList; 29 | import java.util.List; 30 | 31 | /** 32 | * The Promise object represents the eventual completion (or failure) 33 | * of an asynchronous operation, and its resulting value. 34 | *
35 | * A Promise is a proxy for a value not necessarily known when 36 | * the promise is created. It allows you to associate handlers 37 | * with an asynchronous action's eventual success value or failure reason. 38 | * This lets asynchronous methods return values like synchronous methods: 39 | * instead of immediately returning the final value, 40 | * the asynchronous method returns a promise to supply the value 41 | * at some point in the future. 42 | *
43 | * For more information on Javascript Promise 44 | * please visit the official Mozilla Promise documentation 45 | * 46 | * @see 47 | * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise 48 | *
49 | * This Android Promise Library slightly different than the native Javascript Promise. 50 | * This promise object has two imprtant method i.e. `resolve()` and `reject()`, 51 | * whenevey you done withe your process just call resolve or reject 52 | * function based on your state. 53 | * The resultant value will be automaticall passed as argument to the 54 | * followng `then()` or `error()` function. 55 | *
56 | * You can write `n` numbers of `then()` chain. 57 | *
58 | * It supports above JAVA 1.8 59 | */ 60 | 61 | public class Promise { 62 | 63 | private static final String TAG = "Promise"; 64 | private Handler handler; 65 | private OnSuccessListener onSuccessListener; 66 | private OnErrorListener onErrorListener; 67 | private Promise child; 68 | private boolean isResolved; 69 | private Object resolvedObject; 70 | private boolean isRejected; 71 | private Object rejectedObject; 72 | private Object tag; 73 | 74 | 75 | public Promise() { 76 | // Trigger all promise calls in UI thread 77 | // if (Looper.getMainLooper().getThread() == Thread.currentThread()) { 78 | // this.handler = new Handler(); 79 | // } 80 | 81 | this.handler = new Handler(Looper.getMainLooper()); 82 | } 83 | 84 | public static Promise chain(Object obj) { 85 | Promise p = new Promise(); 86 | p.resolve(obj); 87 | return p; 88 | } 89 | 90 | public static Promise all(Promise... list) { 91 | Promise p = new Promise(); 92 | int size = 0; 93 | if (list != null) { 94 | size = list.length; 95 | } 96 | Object results[] = new Object[size]; 97 | if (list == null || list.length <= 0) { 98 | Log.w(TAG, "Promise list should not be empty!"); 99 | p.resolve(results); 100 | return p; 101 | } 102 | 103 | if (list != null && list.length > 0) { 104 | new Runnable() { 105 | int completedCount = 0; 106 | 107 | @Override 108 | public void run() { 109 | for (int i = 0; i < list.length; i++) { 110 | Promise promise = list[i]; 111 | promise.setTag(i); 112 | promise.then(res -> { 113 | results[(int) promise.getTag()] = res; 114 | completed(null); 115 | return res; 116 | }).error(err -> { 117 | completed(err); 118 | }); 119 | } 120 | } 121 | 122 | private void completed(Object err) { 123 | completedCount++; 124 | if (err != null) { 125 | p.reject(err); 126 | } else if (completedCount == list.length) { 127 | p.resolve(results); 128 | } 129 | } 130 | }.run(); 131 | } else { 132 | Log.w(TAG, "Promises should not be empty!"); 133 | p.resolve(results); 134 | } 135 | 136 | 137 | return p; 138 | } 139 | 140 | public static Promise series(List> list, OnSuccessListener listener) { 141 | Promise p = new Promise(); 142 | int size = 0; 143 | if (list != null) { 144 | size = list.size(); 145 | } 146 | ArrayList