Android LiveData Resource: Propagate Data or Exception (Kotlin)

August 19, 2019

Use a Resource object to hold data or exception.

class Resource<out T> private constructor(
    private val data: T?,
    private val error: Throwable?
) {

    val isSuccessful: Boolean
        get() = data != null && error == null

    constructor(data: T) : this(data, null)

    constructor(exception: Throwable) : this(null, exception)

    fun data(): T {
        if (error != null) {
            throw IllegalStateException("Check isSuccessful first: call error() instead.")
        }
        return data!!
    }

    fun error(): Throwable {
        if (data != null) {
            throw IllegalStateException("Check isSuccessful first: call data() instead.")
        }
        return error!!
    }
}

NOTE: Alternative Resource object solution

Usage

val messageLiveData = MutableLiveData<Resource<String>>()

fun getMessage() {
    try {
        // fetch data
        val message = ...
        messageLiveData.value = Resource(message)
    }
    catch (e: Exception) {
        messageLiveData.value = Resource(e)
    }
}

messageLiveData.observe(lifecycleOwner, Observer { event ->
    if (event.isSuccessful) {
        val message = res.data()

        // do something
    }
    else {
        val e = res.error()

        // handle exception
    }
}

❤️ Is this article helpful?

Buy me a coffee☕ or support my work to keep this space 🖖 and ad-free.
If you can't, do send some 💖 to @d_luaz or help to share this article.

👶 Apps I built

Pixtory App (Alpha) - easily organize photos on your phone into a blog.
COVID-19 - data, chart, information & news.
暖心芽 (WIP) 🌞❤️🌱 - reminder of hope, warmth, thoughts and feelings.
Travelopy - travel discovery and journal
LuaPass - offline password manager
WhatIDoNow - a public log of things I am working on now

By Desmond Lua

A dream boy who enjoys making apps, travelling and gardening. Follow me on @d_luaz.

Tags:

Android Use LiveData To Show Toast Message From ViewModel

Guide to learning Android Dev with Kotlin and Architecture Components (ViewModel, LiveData and Room)

Android Keep Track of Edit and View Mode With LiveData (Fragment, Kotlin)

Android LiveData: Handle UI Event With Event Wrapper (SingleLiveEvent Replacement)

Android Create Singleton LiveData to Observe Changes (e.g. User Login and Logout) - Kotlin

Android Firebase Auth AuthStateListener as LiveData (lifecycle-aware)

Android Firestore Query addSnapshotListener as LiveData (lifecycle aware)

Android Firestore Document addSnapshotListener as LiveData (lifecycle aware)

Android Handle RecyclerView Click Event With LiveData