├── lifecycleEvents ├── .gitignore ├── src │ ├── main │ │ ├── AndroidManifest.xml │ │ ├── res │ │ │ └── values │ │ │ │ └── strings.xml │ │ └── java │ │ │ └── robertapikyan │ │ │ └── com │ │ │ └── events │ │ │ ├── implementation │ │ │ ├── EventObserver.kt │ │ │ ├── Disposable.kt │ │ │ ├── lifecycle │ │ │ │ ├── LifecycleDisposable.kt │ │ │ │ ├── PendingEventsRules.kt │ │ │ │ ├── PendingEvents.kt │ │ │ │ └── LifecycleObserver.kt │ │ │ ├── AbstractEventObserver.kt │ │ │ └── EventObservable.kt │ │ │ ├── executors │ │ │ ├── TaskExecutor.kt │ │ │ ├── Threads.kt │ │ │ ├── DefaultExecutor.kt │ │ │ └── TaskExecutors.kt │ │ │ ├── EventObservables.kt │ │ │ └── Events.kt │ ├── test │ │ └── java │ │ │ └── robertapikyan │ │ │ └── com │ │ │ └── events │ │ │ └── ExampleUnitTest.java │ └── androidTest │ │ └── java │ │ └── robertapikyan │ │ └── com │ │ └── events │ │ └── ExampleInstrumentedTest.java ├── proguard-rules.pro └── build.gradle ├── settings.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .idea ├── caches │ └── build_file_checksums.ser ├── markdown-navigator │ └── profiles_settings.xml ├── vcs.xml ├── dictionaries │ └── Robert_Apikyan.xml ├── kotlinc.xml ├── runConfigurations.xml ├── gradle.xml ├── misc.xml ├── codeStyles │ └── Project.xml └── markdown-navigator.xml ├── .gitignore ├── gradle.properties ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE /lifecycleEvents/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':app', ':lifecycleEvents' 2 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RobertApikyan/LifecycleEvents/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /lifecycleEvents/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | LifecycleBus 3 | 4 | -------------------------------------------------------------------------------- /.idea/caches/build_file_checksums.ser: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RobertApikyan/LifecycleEvents/HEAD/.idea/caches/build_file_checksums.ser -------------------------------------------------------------------------------- /.idea/markdown-navigator/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/libraries 5 | /.idea/modules.xml 6 | /.idea/workspace.xml 7 | .DS_Store 8 | /build 9 | /captures 10 | .externalNativeBuild 11 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/dictionaries/Robert_Apikyan.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | robertapikyan 5 | 6 | 7 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/EventObserver.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation 2 | 3 | /** 4 | * @param T event type 5 | */ 6 | interface EventObserver { 7 | fun onEvent(t: T) 8 | } -------------------------------------------------------------------------------- /.idea/kotlinc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 7 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue Aug 14 15:51:23 AMT 2018 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.4-all.zip 7 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/executors/TaskExecutor.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.executors 2 | 3 | abstract class TaskExecutor { 4 | abstract fun executeOnBackgroundThread(runnable: Runnable) 5 | 6 | abstract fun executeOnMainThread(runnable: Runnable) 7 | 8 | abstract fun isMainThread(): Boolean 9 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/executors/Threads.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.executors 2 | 3 | enum class Threads { 4 | BACKGROUND, 5 | MAIN; 6 | 7 | internal fun execute(block: () -> Unit) { 8 | when (this) { 9 | MAIN -> TaskExecutors.executeOnMainThread(block) 10 | BACKGROUND -> TaskExecutors.executeOnBackgroundThread(block) 11 | } 12 | } 13 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/Disposable.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation 2 | 3 | interface Disposable { 4 | 5 | /** 6 | * This method will remove event observable from observable observers list 7 | */ 8 | fun dispose() 9 | 10 | companion object { 11 | fun fromLambda(dispose: () -> Unit) = object : Disposable { 12 | override fun dispose() = dispose() 13 | } 14 | } 15 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/test/java/robertapikyan/com/events/ExampleUnitTest.java: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events; 2 | 3 | import org.junit.Test; 4 | 5 | import static org.junit.Assert.*; 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * @see Testing documentation 11 | */ 12 | public class ExampleUnitTest { 13 | @Test 14 | public void addition_isCorrect() { 15 | assertEquals(4, 2 + 2); 16 | } 17 | } -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 12 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/lifecycle/LifecycleDisposable.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation.lifecycle 2 | 3 | import robertapikyan.com.events.implementation.AbstractEventObserver 4 | 5 | interface LifecycleDisposable { 6 | 7 | /** 8 | * This method will remove event observable from observable observers list, 9 | * with remove self strategy 10 | */ 11 | fun dispose(eventObserver: AbstractEventObserver) 12 | 13 | companion object { 14 | fun fromLambda(dispose: (AbstractEventObserver) -> Unit) = object : LifecycleDisposable { 15 | override fun dispose(eventObserver: AbstractEventObserver) = dispose(eventObserver) 16 | } 17 | } 18 | } -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 19 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx1536m 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/EventObservables.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("MemberVisibilityCanBePrivate") 2 | 3 | package robertapikyan.com.events 4 | 5 | import robertapikyan.com.events.implementation.EventObservable 6 | 7 | /** 8 | * Observable holder singleton 9 | */ 10 | @Suppress("UNCHECKED_CAST") 11 | class EventObservables { 12 | 13 | // use observeEvent(observer: AbstractEventObserver) and observeEvent(lifecycleOwner: LifecycleOwner,observer: 14 | // AbstractEventObserver), do not user this observable directly 15 | // and do not access this field with explicit reference 16 | 17 | companion object { 18 | @PublishedApi 19 | internal val observable by lazy(LazyThreadSafetyMode.SYNCHRONIZED) { EventObservable() } 20 | } 21 | } -------------------------------------------------------------------------------- /lifecycleEvents/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /lifecycleEvents/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.library' 2 | apply plugin: 'kotlin-android' 3 | 4 | android { 5 | compileSdkVersion 27 6 | 7 | defaultConfig { 8 | minSdkVersion 14 9 | targetSdkVersion 27 10 | versionCode 1 11 | versionName "0.0.1" 12 | 13 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 14 | } 15 | 16 | buildTypes { 17 | release { 18 | minifyEnabled false 19 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 20 | } 21 | } 22 | 23 | } 24 | 25 | dependencies { 26 | implementation fileTree(dir: 'libs', include: ['*.jar']) 27 | implementation 'com.android.support:appcompat-v7:27.1.1' 28 | implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" 29 | } 30 | repositories { 31 | mavenCentral() 32 | } 33 | -------------------------------------------------------------------------------- /lifecycleEvents/src/androidTest/java/robertapikyan/com/events/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events; 2 | 3 | import android.content.Context; 4 | import android.support.test.InstrumentationRegistry; 5 | import android.support.test.runner.AndroidJUnit4; 6 | 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | 10 | import static org.junit.Assert.*; 11 | 12 | /** 13 | * Instrumented test, which will execute on an Android device. 14 | * 15 | * @see Testing documentation 16 | */ 17 | @RunWith(AndroidJUnit4.class) 18 | public class ExampleInstrumentedTest { 19 | @Test 20 | public void useAppContext() { 21 | // Context of the app under test. 22 | Context appContext = InstrumentationRegistry.getTargetContext(); 23 | 24 | assertEquals("robertapikyan.com.lifecyclebus.test", appContext.getPackageName()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/lifecycle/PendingEventsRules.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation.lifecycle 2 | 3 | /** 4 | * With this rules we can specify how to handle events when lifecycleOwner state is out of 5 | * (onStart - onStop) state 6 | */ 7 | enum class PendingEventsRules { 8 | IGNORE, // if lifecycleOwner state is out of onStart and onStop, 9 | // in that period all received events will be ignored 10 | IN_ORDER, // all pending events will be delivered after onStart, with the same ordering as they received (FIFO) 11 | REVERSE_ORDER, // all pending events will be delivered after onStop, with the same ordering as they received (LIFO) 12 | ONLY_LAST, // only last received event will be delivered after onStop 13 | ONLY_FIRST, // only first received event will be delivered after onStop 14 | IMMEDIATE; // events will be received, even after onStop 15 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/executors/DefaultExecutor.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.executors 2 | 3 | import android.os.Handler 4 | import android.os.Looper 5 | import java.util.concurrent.Executors 6 | 7 | class DefaultExecutor : TaskExecutor() { 8 | 9 | private companion object { 10 | const val POOL_SIZE = 3 11 | } 12 | 13 | private val executorService = Executors.newFixedThreadPool(POOL_SIZE) 14 | 15 | private val mainHandler by lazy(LazyThreadSafetyMode.SYNCHRONIZED) { 16 | Handler(Looper.getMainLooper()) 17 | } 18 | 19 | override fun executeOnBackgroundThread(runnable: Runnable) { 20 | executorService.execute(runnable) 21 | } 22 | 23 | override fun executeOnMainThread(runnable: Runnable) { 24 | if (isMainThread()) 25 | runnable.run() 26 | else 27 | mainHandler.post(runnable) 28 | } 29 | 30 | override fun isMainThread() = Looper.getMainLooper().thread.id == Thread.currentThread().id 31 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/AbstractEventObserver.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation 2 | 3 | import robertapikyan.com.events.executors.Threads 4 | import robertapikyan.com.events.implementation.lifecycle.PendingEventsRules 5 | 6 | abstract class AbstractEventObserver(val observableClass: Class, 7 | val receiveOn: Threads = Threads.MAIN, 8 | val rule: PendingEventsRules = PendingEventsRules.IN_ORDER) 9 | : EventObserver { 10 | 11 | companion object { 12 | fun fromLambda(clazz: Class, receiveOn: Threads, rule: PendingEventsRules, eventObserver: (T) -> Unit) = 13 | object : AbstractEventObserver(clazz, receiveOn, rule) { 14 | override fun onEvent(t: T) = eventObserver(t) 15 | } 16 | } 17 | 18 | internal constructor(eventObserver: AbstractEventObserver) : this( 19 | eventObserver.observableClass, 20 | eventObserver.receiveOn, 21 | eventObserver.rule 22 | ) 23 | 24 | internal open fun event(t: T) = receiveOn.execute { onEvent(t) } 25 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/executors/TaskExecutors.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.executors 2 | 3 | class TaskExecutors : TaskExecutor() { 4 | 5 | companion object { 6 | private val instance by lazy(LazyThreadSafetyMode.SYNCHRONIZED) { TaskExecutors() } 7 | 8 | fun executeOnBackgroundThread(runnable: () -> Unit) = 9 | instance.executeOnBackgroundThread(Runnable(runnable)) 10 | 11 | fun executeOnMainThread(runnable: () -> Unit) = 12 | instance.executeOnMainThread(Runnable(runnable)) 13 | 14 | } 15 | 16 | private var executor: TaskExecutor 17 | 18 | private val defaultExecutor: TaskExecutor = DefaultExecutor() 19 | 20 | init { 21 | executor = defaultExecutor 22 | } 23 | 24 | fun setTaskExecutor(executor: TaskExecutor) { 25 | this.executor = executor 26 | } 27 | 28 | override fun executeOnBackgroundThread(runnable: Runnable) = 29 | executor.executeOnBackgroundThread(runnable) 30 | 31 | override fun executeOnMainThread(runnable: Runnable) = 32 | executor.executeOnMainThread(runnable) 33 | 34 | override fun isMainThread() = 35 | executor.isMainThread() 36 | } -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/lifecycle/PendingEvents.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation.lifecycle 2 | 3 | import java.util.* 4 | 5 | class PendingEvents(private val policy: PendingEventsRules, 6 | private val events: LinkedList = LinkedList()) : 7 | Queue by events { 8 | 9 | override fun add(element: T): Boolean { 10 | return when (policy) { 11 | 12 | PendingEventsRules.IN_ORDER -> events.add(element) 13 | 14 | PendingEventsRules.REVERSE_ORDER -> { 15 | events.addFirst(element) 16 | return true 17 | } 18 | 19 | PendingEventsRules.ONLY_FIRST -> { 20 | if (events.isEmpty()) { 21 | events.addFirst(element) 22 | return true 23 | } 24 | return false 25 | } 26 | 27 | PendingEventsRules.ONLY_LAST -> { 28 | events.clear() 29 | events.addFirst(element) 30 | return true 31 | } 32 | 33 | PendingEventsRules.IGNORE -> false 34 | 35 | PendingEventsRules.IMMEDIATE -> false 36 | } 37 | } 38 | } -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 17 | 27 | 28 | 29 | 30 | 31 | 32 | 34 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 15 | 16 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/lifecycle/LifecycleObserver.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation.lifecycle 2 | 3 | import android.arch.lifecycle.Lifecycle 4 | import android.arch.lifecycle.LifecycleObserver 5 | import android.arch.lifecycle.LifecycleOwner 6 | import android.arch.lifecycle.OnLifecycleEvent 7 | import robertapikyan.com.events.implementation.AbstractEventObserver 8 | import robertapikyan.com.events.implementation.Disposable 9 | import java.util.concurrent.locks.ReentrantLock 10 | 11 | internal class LifecycleObserver( 12 | lifecycleOwner: LifecycleOwner, 13 | private val observer: AbstractEventObserver, 14 | private val disposable: LifecycleDisposable 15 | ) : LifecycleObserver, Disposable, AbstractEventObserver(observer) { 16 | 17 | private val lock by lazy { ReentrantLock() } 18 | 19 | private val pendingEvents by lazy { PendingEvents(observer.rule) } 20 | 21 | @Volatile 22 | private var isActive = true 23 | 24 | init { 25 | lifecycleOwner.lifecycle.addObserver(this) 26 | } 27 | 28 | private fun dispatchPendings() { 29 | lock.lock() 30 | while (!pendingEvents.isEmpty()) { 31 | onEvent(pendingEvents.poll()) 32 | } 33 | lock.unlock() 34 | } 35 | 36 | @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY) 37 | fun onDestroy() { 38 | dispose() 39 | } 40 | 41 | @OnLifecycleEvent(Lifecycle.Event.ON_START) 42 | fun onStart() { 43 | isActive = true 44 | dispatchPendings() 45 | } 46 | 47 | @OnLifecycleEvent(Lifecycle.Event.ON_STOP) 48 | fun onStop() { 49 | isActive = false 50 | } 51 | 52 | override fun event(t: T) { 53 | if (isActive || observer.rule == PendingEventsRules.IMMEDIATE) { 54 | onEvent(t) 55 | } else { 56 | lock.lock() 57 | pendingEvents.add(t) 58 | lock.unlock() 59 | } 60 | } 61 | 62 | override fun onEvent(t: T) = observer.event(t) 63 | 64 | override fun dispose() { 65 | disposable.dispose(this) 66 | } 67 | } -------------------------------------------------------------------------------- /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 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 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 Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/implementation/EventObservable.kt: -------------------------------------------------------------------------------- 1 | package robertapikyan.com.events.implementation 2 | 3 | import android.arch.lifecycle.LifecycleOwner 4 | import robertapikyan.com.events.executors.Threads 5 | import robertapikyan.com.events.implementation.lifecycle.LifecycleDisposable 6 | import robertapikyan.com.events.implementation.lifecycle.LifecycleObserver 7 | import java.util.* 8 | import java.util.concurrent.locks.ReentrantLock 9 | 10 | /** 11 | * @param T event type 12 | */ 13 | class EventObservable { 14 | 15 | private val lock by lazy { ReentrantLock() } 16 | 17 | private val observables = HashMap, LinkedList>>() 18 | 19 | fun observe(observer: AbstractEventObserver): Disposable { 20 | addObserver(observer.observableClass, observer) 21 | return Disposable.fromLambda { removeObserver(observer.observableClass, observer) } 22 | } 23 | 24 | fun observe(lifecycleOwner: LifecycleOwner, 25 | observer: AbstractEventObserver): Disposable { 26 | val lifecycleObserver = LifecycleObserver(lifecycleOwner, 27 | observer, 28 | LifecycleDisposable.fromLambda { removeObserver(observer.observableClass, it) }) 29 | addObserver(observer.observableClass, lifecycleObserver) 30 | return lifecycleObserver 31 | } 32 | 33 | fun sendEvent(eventObj: T, sendOn: Threads) = sendOn.execute { 34 | lockObservables { 35 | val typeObservers = observables[eventObj::class.java] 36 | 37 | if (typeObservers != null) { 38 | for (observer in typeObservers) 39 | observer.event(eventObj) 40 | } 41 | } 42 | } 43 | 44 | private fun addObserver(key: Class, observer: AbstractEventObserver) = lockObservables { 45 | var typeObservers = observables[key] 46 | 47 | if (typeObservers == null) { 48 | typeObservers = LinkedList() 49 | observables[key] = typeObservers 50 | } 51 | 52 | typeObservers.add(observer) 53 | } 54 | 55 | private fun removeObserver(key: Class, observer: AbstractEventObserver) = lockObservables { 56 | 57 | val typeObservers = observables[key] ?: return@lockObservables 58 | 59 | typeObservers.remove(observer) 60 | 61 | if (typeObservers.isEmpty()) { 62 | observables.remove(key) 63 | } 64 | } 65 | 66 | private fun lockObservables(synchronized: () -> Unit) { 67 | lock.lock() 68 | synchronized() 69 | lock.unlock() 70 | } 71 | } -------------------------------------------------------------------------------- /.idea/markdown-navigator.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 36 | 37 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![N|Solid](https://raw.githubusercontent.com/RobertApikyan/LifecycleEvents/intro/Intro/intro.png?raw=true) 2 | 3 | ### MinSDK 14+ 4 | [![](https://jitpack.io/v/RobertApikyan/LifecycleEvents.svg)](https://jitpack.io/#RobertApikyan/LifecycleEvents) 5 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 6 | 7 | 8 | ### LifecycleEvents 9 | 10 | LifecycleEvents library is an event bus implementation, using lifecycle from android architecture components and kotlin language features. 11 | It is also designed for Java language. 12 | ### Simple Usage 13 | LifecycleEvents allows us to send any object as an event, 14 | In this example, UserInfo's instance will be send as an event. 15 | ##### kotlin 16 | ```kotlin 17 | ... 18 | // Sending userInfo as an event 19 | userInfo.sendAsEvent() // sendAsEvent is a kotlin extention method, for java user Events.sendEvent(userInfo) mthod 20 | ... 21 | 22 | // Receiving userInfo 23 | disposable = observeEvent { userInfo -> 24 | // use userInfo object here 25 | } 26 | ... 27 | 28 | // Cancel event observation 29 | disposable.dispose() 30 | ... 31 | ```` 32 | ##### java 33 | ```java 34 | ... 35 | 36 | // Sending userInfo as an event 37 | Events.sendEvent(userInfo); 38 | ... 39 | 40 | // Receiving userInfo 41 | disposable = Events.observeEvent(UserInfo.class, userInfo ->{ 42 | // use userInfo object here 43 | }); 44 | ... 45 | 46 | // Cancel event observation 47 | disposable.dispose() 48 | ... 49 | ```` 50 | ## With Android Lifecycle 51 | While observing events inside Activity or Fragment we do not need to cancel event observation manually, we can just pass lifecycleOwner instance as an observeEvent method's argument, and dispose() method will be called automatically with onDestroy() lifecycle method. 52 | ##### kotlin 53 | ```kotlin 54 | observeEvent(lifecycleOwner: this) { userInfo -> 55 | // use userInfo object here 56 | } 57 | ``` 58 | ## Pending Events Handling 59 | Observation with lifecycleOwner allows us to handle events only when activity or fragment are at list started but not stopped. 60 | Events that are arrived when activity/fragment is in the stopped state will be marked as pending events, and will be delivered 61 | with onStart() lifecycle method. By default pending events will delivered with the same receiving order, 62 | but we can change delivery behavior by setting observeEvent method's rule attribute. 63 | ##### kotlin 64 | ```kotlin 65 | // After onStart() Only the last event will be delivered 66 | observeEvent(this, PendingEventsRules.ONLY_LAST) { userInfo -> 67 | // use userInfo object here 68 | } 69 | ``` 70 | #### There are five types of PendingEventsRules 71 | ##### 1. IGNORE 72 | ##### 2. IN_ORDER // default 73 | ##### 3. REVERSE_ORDER 74 | ##### 4. ONLY_LAST 75 | ##### 5. ONLY_FIRST 76 | ##### 6. IMMEDIATE // events will be delivered, even after onStop() 77 | 78 | ## Threads Handling 79 | By default all events will be sent and received on the main thread, but we can change this. 80 | In the above example, event observation will be done on the background worker thread (do this if you have big number of observers for specified event), 81 | and the event will be received on the main thread. 82 | ##### kotlin 83 | ```kotlin 84 | ... 85 | // observers will be iterated on the background worker thread 86 | user.sendAsEvent(Threads.BACKGROUND) 87 | ... 88 | // event will be recieved on the main thread (here you can not specify Threads.MAIN, it is the default value) 89 | observeEvent(this, Threads.MAIN) { userInfo -> 90 | // use userInfo object here 91 | } 92 | 93 | // also you can specify Threads.BACKGROUND, in order to receive events on the background worker thread 94 | observeEvent(this, Threads.BACKGROUND) { userInfo -> 95 | // use userInfo object here 96 | } 97 | ``` 98 | ### Add to Project 99 | ##### Add to project level build.gradle 100 | ```groovy 101 | allprojects { 102 | repositories { 103 | ... 104 | maven { url 'https://jitpack.io' } 105 | } 106 | } 107 | ``` 108 | ###### Add to app module level build.gradle 109 | ```groovy 110 | dependencies { 111 | implementation 'com.github.RobertApikyan:LifecycleEvents:1.0.1' 112 | } 113 | ``` 114 | ##### Maven 115 | 116 | ```xml 117 | 118 | 119 | jitpack.io 120 | https://jitpack.io 121 | 122 | 123 | ``` 124 | ###### Add the dependency 125 | ```xml 126 | 127 | com.github.RobertApikyan 128 | LifecycleEvents 129 | 1.0.1 130 | 131 | ``` 132 | 133 | [![View Robert Apikyan profile on LinkedIn](https://www.linkedin.com/img/webpromo/btn_viewmy_160x33.png)](https://www.linkedin.com/in/robert-apikyan-24b915130/) 134 | 135 | License 136 | ------- 137 | 138 | Copyright 2018 Robert Apikyan 139 | 140 | Licensed under the Apache License, Version 2.0 (the "License"); 141 | you may not use this file except in compliance with the License. 142 | You may obtain a copy of the License at 143 | 144 | http://www.apache.org/licenses/LICENSE-2.0 145 | 146 | Unless required by applicable law or agreed to in writing, software 147 | distributed under the License is distributed on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 149 | See the License for the specific language governing permissions and 150 | limitations under the License. 151 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> $.*$$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /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 [yyyy] [name of copyright owner] 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 | -------------------------------------------------------------------------------- /lifecycleEvents/src/main/java/robertapikyan/com/events/Events.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("UNCHECKED_CAST") 2 | @file:JvmName("Events") 3 | 4 | package robertapikyan.com.events 5 | 6 | import android.arch.lifecycle.LifecycleOwner 7 | import org.jetbrains.annotations.NotNull 8 | import robertapikyan.com.events.executors.Threads 9 | import robertapikyan.com.events.implementation.AbstractEventObserver 10 | import robertapikyan.com.events.implementation.EventObserver 11 | import robertapikyan.com.events.implementation.lifecycle.PendingEventsRules 12 | 13 | /** 14 | * EXAMPLE 15 | * 16 | * // here is data class 17 | * data class User(val userName:String,val age:Int, ...) 18 | * 19 | * // the sender activity 20 | * class FarFarAwayFromReceiverActivity : AppCompatActivity(){ 21 | * 22 | * ... 23 | * override fun onCreate(savedInstanceState: Bundle?) { 24 | * super.onCreate(savedInstanceState) 25 | * setContentView(R.layout....) 26 | * } 27 | * 28 | * override fun onUserFetchSuccess(user:User){ 29 | * user.sendAsEvent() // with kotlin extension method sendAsEvent 30 | * } 31 | * ... 32 | * 33 | * } 34 | * 35 | * // receiver activity 36 | * class ReceiverActivity : AppCompatActivity() { 37 | * 38 | * ... 39 | * 40 | * override fun onCreate(savedInstanceState: Bundle?) { 41 | * super.onCreate(savedInstanceState) 42 | * 43 | * setContentView(R.layout....) 44 | * 45 | * // 1. first option 46 | * observeEvent(lifecycleOwner = this) { user -> 47 | * /*do you user work*/ 48 | * } 49 | * 50 | * // 2. second option 51 | * observeEvent(lifecycleOwner = this, 52 | * rules = PendingEventsRules.ONLY_LAST) // only the last event from pendings will be received 53 | * { user -> 54 | * /*do you user work*/ 55 | * } 56 | * 57 | * // 3. option three 58 | * observeEvent(lifecycleOwner = this, 59 | * receiveOn = Threads.BACKGROUND // events will be received on the background thread 60 | * rules = PendingEventsRules.REVERSE_ORDER) // pending events will be received in reversed order 61 | * { user -> 62 | * /*do you user work, but be careful your on background thread ;) */ 63 | * } 64 | * 65 | * .... 66 | * } 67 | * 68 | * ... 69 | * } 70 | * 71 | */ 72 | 73 | /** 74 | * Use this extension method in order to send events directly from event class. 75 | * Any not null object can be send as an event 76 | * Example. 77 | * 78 | * val user = User(name= "Rob",age= 14, ... ) 79 | * // now you can send user object as an event 80 | * user.sendAsEvent() 81 | * 82 | * @param T is event type. 83 | * @param sendOn is specified as MAIN or BACKGROUND, default value is MAIN, use BACKGROUND if there 84 | * is a big number of observers for specified event type. 85 | */ 86 | fun T.sendAsEvent(sendOn: Threads = Threads.MAIN) = 87 | sendEvent(this, sendOn) 88 | 89 | /** 90 | * 91 | * Use this method in order to send events. 92 | * Any not null object can be send as an event 93 | * 94 | * @param T is event type. 95 | * @param event, not null data class 96 | * 97 | */ 98 | fun sendEvent(@NotNull event: T) = sendEvent(event, Threads.MAIN) 99 | 100 | /** 101 | * Use this method in order to send events. 102 | * Any not null object can be send as an event 103 | * Example. 104 | * 105 | * val user = User(name= "Rob",age= 14, ... ) 106 | * // now you can send user object as an event 107 | * user.sendAsEvent() 108 | * 109 | * @param T is event type. 110 | * @param event, not null data class 111 | * @param sendOn is specified as MAIN or BACKGROUND, use BACKGROUND if there 112 | * is a big number of observers for specified event type. 113 | */ 114 | fun sendEvent(@NotNull event: T, sendOn: Threads) { 115 | @Suppress("SENSELESS_COMPARISON") 116 | if (event != null) { 117 | EventObservables.observable.sendEvent(event, sendOn) 118 | } 119 | } 120 | 121 | /** 122 | * Use this class to start observing for specified event type 123 | */ 124 | fun observeEvent(observer: AbstractEventObserver) = 125 | EventObservables.observable.observe(observer as AbstractEventObserver) 126 | 127 | /** 128 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 129 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 130 | * between onStart and onStop, events that are out off this state will be delivered later or will be 131 | * ignored, it depends on specified rules [PendingEventsRules] 132 | * 133 | * @param receiveOn is the thread where event will be delivered, 134 | * by default observations are invoking on the MAIN thread 135 | */ 136 | inline fun observeEvent(receiveOn: Threads = Threads.MAIN, 137 | noinline observer: (T) -> Unit) = 138 | EventObservables.observable.observe(AbstractEventObserver.fromLambda(T::class.java, receiveOn, PendingEventsRules.IN_ORDER, observer) 139 | as AbstractEventObserver) 140 | 141 | /** 142 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 143 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 144 | * between onStart and onStop, events that are out off this state will be delivered later or will be 145 | * ignored, it depends on specified rules [PendingEventsRules] 146 | * @return [robertapikyan.com.events.implementation.Disposable], 147 | * after calling disposable.dispose() method the observable will be removed 148 | */ 149 | fun observeEvent(lifecycleOwner: LifecycleOwner, 150 | observer: AbstractEventObserver) = 151 | EventObservables.observable.observe(lifecycleOwner, observer 152 | as AbstractEventObserver) 153 | 154 | /** 155 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 156 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 157 | * between onStart and onStop, events that are out off this state will be delivered later or will be 158 | * ignored, it depends on specified rules [PendingEventsRules] 159 | * 160 | * @param receiveOn is the thread where event will be delivered, 161 | * by default observations are invoking on the MAIN thread 162 | * @param rule is the pending events handling policy, pending events are thous events that are received 163 | * when lifecycleOwner is not visible ( after onStop() callback ), by default all events will be delivered 164 | * after lifecycleOwner onStart callback, with the same ordering 165 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 166 | * @return [robertapikyan.com.events.implementation.Disposable], 167 | * after calling disposable.dispose() method the observable will be removed 168 | */ 169 | inline fun observeEvent(lifecycleOwner: LifecycleOwner, 170 | receiveOn: Threads = Threads.MAIN, 171 | rule: PendingEventsRules = PendingEventsRules.IN_ORDER, 172 | noinline observer: (T) -> Unit) = 173 | EventObservables.observable.observe(lifecycleOwner, 174 | AbstractEventObserver.fromLambda(T::class.java, receiveOn, rule, observer) 175 | as AbstractEventObserver) 176 | 177 | /** 178 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 179 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 180 | * between onStart and onStop, events that are out off this state will be delivered later or will be 181 | * ignored, it depends on specified rules [PendingEventsRules] 182 | * 183 | * @param rule is the pending events handling policy, pending events are thous events that are received 184 | * when lifecycleOwner is not visible ( after onStop() callback ), by default all events will be delivered 185 | * after lifecycleOwner onStart callback, with the same ordering 186 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 187 | * @return [robertapikyan.com.events.implementation.Disposable], 188 | * after calling disposable.dispose() method the observable will be removed 189 | */ 190 | inline fun observeEvent(lifecycleOwner: LifecycleOwner, 191 | rule: PendingEventsRules = PendingEventsRules.IN_ORDER, 192 | noinline observer: (T) -> Unit) = 193 | EventObservables.observable.observe(lifecycleOwner, 194 | AbstractEventObserver.fromLambda(T::class.java, Threads.MAIN, rule, observer) 195 | as AbstractEventObserver) 196 | 197 | /** 198 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 199 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 200 | * between onStart and onStop, events that are out off this state will be delivered later or will be 201 | * ignored, it depends on specified rules [PendingEventsRules] 202 | * 203 | * @param observableClass is the type of event that will be observed 204 | * @param receiveOn is the thread where event will be delivered, 205 | * by default observations are invoking on the MAIN thread 206 | * @param rule is the pending events handling policy, pending events are thous events that are received 207 | * when lifecycleOwner is not visible ( after onStop() callback ), by default all events will be delivered 208 | * after lifecycleOwner onStart callback, with the same ordering 209 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 210 | * @return [robertapikyan.com.events.implementation.Disposable], 211 | * after calling disposable.dispose() method the observable will be removed 212 | */ 213 | fun observeEvent(observableClass: Class, 214 | lifecycleOwner: LifecycleOwner, 215 | receiveOn: Threads = Threads.MAIN, 216 | rule: PendingEventsRules = PendingEventsRules.IN_ORDER, 217 | observer: EventObserver) = 218 | EventObservables.observable.observe(lifecycleOwner, AbstractEventObserver 219 | .fromLambda(observableClass, receiveOn, rule, observer::onEvent) as AbstractEventObserver) 220 | 221 | /** 222 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 223 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 224 | * between onStart and onStop, events that are out off this state will be delivered later or will be 225 | * ignored, it depends on specified rules [PendingEventsRules] 226 | * 227 | * @param observableClass is the type of event that will be observed 228 | * @param rule is the pending events handling policy, pending events are thous events that are received 229 | * when lifecycleOwner is not visible ( after onStop() callback ), by default all events will be delivered 230 | * after lifecycleOwner onStart callback, with the same ordering 231 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 232 | * @return [robertapikyan.com.events.implementation.Disposable], 233 | * after calling disposable.dispose() method the observable will be removed 234 | */ 235 | fun observeEvent(observableClass: Class, 236 | lifecycleOwner: LifecycleOwner, 237 | rule: PendingEventsRules = PendingEventsRules.IN_ORDER, 238 | observer: EventObserver) = 239 | observeEvent(observableClass, lifecycleOwner, Threads.MAIN, rule, observer) 240 | 241 | /** 242 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 243 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 244 | * between onStart and onStop, events that are out off this state will be delivered later or will be 245 | * ignored, it depends on specified rules [PendingEventsRules] 246 | * 247 | * @param observableClass is the type of event that will be observed 248 | * @param receiveOn is the thread where event will be delivered, 249 | * by default observations are invoking on the MAIN thread 250 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 251 | * @return [robertapikyan.com.events.implementation.Disposable], 252 | * after calling disposable.dispose() method the observable will be removed 253 | */ 254 | fun observeEvent(observableClass: Class, 255 | lifecycleOwner: LifecycleOwner, 256 | receiveOn: Threads = Threads.MAIN, 257 | observer: EventObserver) = 258 | observeEvent(observableClass, lifecycleOwner, receiveOn, PendingEventsRules.IN_ORDER, observer) 259 | 260 | /** 261 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 262 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 263 | * between onStart and onStop, events that are out off this state will be delivered later or will be 264 | * ignored, it depends on specified rules [PendingEventsRules] 265 | * 266 | * @param observableClass is the type of event that will be observed 267 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 268 | * @return [robertapikyan.com.events.implementation.Disposable], 269 | * after calling disposable.dispose() method the observable will be removed 270 | */ 271 | fun observeEvent(observableClass: Class, 272 | lifecycleOwner: LifecycleOwner, 273 | observer: EventObserver) = 274 | observeEvent(observableClass, lifecycleOwner, Threads.MAIN, PendingEventsRules.IN_ORDER, observer) 275 | 276 | 277 | fun observeEvent(observableClass: Class, 278 | receiveOn: Threads = Threads.MAIN, 279 | rule: PendingEventsRules = PendingEventsRules.IN_ORDER, 280 | observer: EventObserver) = 281 | EventObservables.observable.observe(AbstractEventObserver 282 | .fromLambda(observableClass, receiveOn, rule, observer::onEvent) as AbstractEventObserver) 283 | 284 | /** 285 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 286 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 287 | * between onStart and onStop, events that are out off this state will be delivered later or will be 288 | * ignored, it depends on specified rules [PendingEventsRules] 289 | * 290 | * @param observableClass is the type of event that will be observed 291 | * @param rule is the pending events handling policy, pending events are thous events that are received 292 | * when lifecycleOwner is not visible ( after onStop() callback ), by default all events will be delivered 293 | * after lifecycleOwner onStart callback, with the same ordering 294 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 295 | * @return [robertapikyan.com.events.implementation.Disposable], 296 | * after calling disposable.dispose() method the observable will be removed 297 | */ 298 | fun observeEvent(observableClass: Class, 299 | rule: PendingEventsRules = PendingEventsRules.IN_ORDER, 300 | observer: EventObserver) = 301 | observeEvent(observableClass, Threads.MAIN, rule, observer) 302 | 303 | /** 304 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 305 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 306 | * between onStart and onStop, events that are out off this state will be delivered later or will be 307 | * ignored, it depends on specified rules [PendingEventsRules] 308 | * 309 | * @param observableClass is the type of event that will be observed 310 | * @param receiveOn is the thread where event will be delivered, 311 | * by default observations are invoking on the MAIN thread 312 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 313 | * @return [robertapikyan.com.events.implementation.Disposable], 314 | * after calling disposable.dispose() method the observable will be removed 315 | */ 316 | fun observeEvent(observableClass: Class, 317 | receiveOn: Threads = Threads.MAIN, 318 | observer: EventObserver) = 319 | observeEvent(observableClass, receiveOn, PendingEventsRules.IN_ORDER, observer) 320 | 321 | /** 322 | * Use this class to start observing for specified event type, this method receives lifecycleOwner 323 | * as an argument, end events will be delivered to observable only if lifecycleOwner's lifecycle state is 324 | * between onStart and onStop, events that are out off this state will be delivered later or will be 325 | * ignored, it depends on specified rules [PendingEventsRules] 326 | * 327 | * @param observableClass is the type of event that will be observed 328 | * @param observer this observer will be automatically removed when lifecycleOwner is destroyed 329 | * @return [robertapikyan.com.events.implementation.Disposable], 330 | * after calling disposable.dispose() method the observable will be removed 331 | */ 332 | fun observeEvent(observableClass: Class, 333 | observer: EventObserver) = 334 | observeEvent(observableClass, Threads.MAIN, PendingEventsRules.IN_ORDER, observer) 335 | 336 | 337 | 338 | --------------------------------------------------------------------------------