commonMain.com.github.hadilq.androidlifecyclehandler.Life.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of android-lifecycle-handler-metadata Show documentation

This library is a simplifier for unnecessary complex lifecycles of `androidx.lifecycle:lifecycle-extensions`.

The newest version!

/**
 * Copyright 2020 Hadi Lashkari Ghouchani

 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at

 * http://www.apache.org/licenses/LICENSE-2.0

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.hadilq.androidlifecyclehandler

/***
 * Defines an object with simply two callbacks [onBorn] and [onDie] to complete the lifecycle. The time after
 * calling [onBorn] and before [onDie] is when the object is alive.
 *
 * [LifeHandler] is able to register this object.
 * In Android platform, [AndroidLifeHandler] is extending [LifeHandler].
 */
interface Life {

    /**
     * Calls when the life starts, depending on the [LifeSpan] while registering. This method will be called
     * onCreate, onStart or onResume of the LifecycleOwner.
     *
     *  It doesn't make sense to make [onBorn] and [onDie] methods thread-safe.
     */
    fun onBorn()

    /**
     * Calls when the life ends, depending on the [LifeSpan] while registering. This method will be called
     * onPause, onStop or onDestroy of the LifecycleOwner.
     *
     * It doesn't make sense to make [onBorn] and [onDie] methods thread-safe.
     */
    fun onDie()
}