An Adapter class build on top of Epoxy's Typed2EpoxyController, which handles the following states:
STATE_LOADINGfor the initial, loading stateSTATE_LOADING_MOREin case of pagination, to show a loader after the list itemsSTATE_SUCCESSthe successful stateSTATE_EMPTYthe empty stateSTATE_ERRORthe error state
This was done to keep things simple between developers, so instead of handling different states with different conditions in lifecycle classes, we decided to handle it in controller classes, with dedicated callback functions, to improve readability & maintainence.
- Add the following in your root
build.gradleat the end of repositories:
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}- In your module-level
build.gradle:
implementation 'com.github.premacck:Swec:1.0.0'- Add the JitPack repository to your build file:
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>- Add the dependency
<dependency>
<groupId>com.github.premacck</groupId>
<artifactId>Swec</artifactId>
<version>1.0.0</version>
</dependency>- Create a controller class extending
StateAwareEpoxyControllerorStateAwareEpoxyControllerList(for a List).
class MyStateAwareController : StateAwareEpoxyControllerList<Item>() {
init {
// Use this to have the `onLoadingState()` called initially
setLoadingState()
}
override fun onLoadingState() {
// Add loader/shimmer item here
loaderItem { id("Loader item for $this") }
}
override fun onLoadingMoreState(data: List<Item>) {
// This will only be called when data is not null
loadData(data)
loadMoreItem { id("Load More Item for ${this@SwecController}") }
}
override fun onSuccessState(data: List<T>?) {
loadData(data)
}
private fun loadData(data: List<T>?) {
// Load your data from `data`, as you would do normally in an `EpoxyController`
}
override fun onErrorOrEmptyState(data: List<T>?) {
// Handle combined error/empty states
}
}- By default,
STATE_EMPTY&STATE_ERRORwill both invokeonErrorOrEmptyState(data: List<T>?) - If you want to handle Error and Empty states differently, then pass
sameErrorAndEmptyStates = falseto the constructor of parent class
class MyStateAwareController : StateAwareEpoxyControllerList<Item>(sameErrorAndEmptyStates = false) {
// Other implementations
override fun onErrorState() {
// Handle Error state
}
override fun onEmptyState() {
// Handle Empty state
}
}-
In your UI class:
- The
setData(data)function takes care of setting the states for you, according to the following conditions:- If the object or List is
null,LoadStatewill beSTATE_ERROR - If the object is a list and the List is empty, the
LoadStatewill beSTATE_EMPTY - If the object or List is not null or empty,
LoadStatewill beSTATE_SUCCESS
- If the object or List is
- But of course, you can go ahead and specify your
LoadStateexplicitly as well.
- The
-
UI class implementation
class ListActivity : AppCompatActivity() {
// ...
private val controller by lazy { MyStateAwareController() }
//...
private fun initRecyclerView() {
epoxyyRecyclerView.setController(controller)
}
private fun fetchData() {
someNetworkCall { response ->
// Assuming response.data is a list of items
setData(response.data)
}
}
private fun setData(list: List<Items>?) {
// This will handle the STATE_SUCCESS, STATE_ERROR & STATE_EMPTY automatically according to the logic explained above
controller.setData(list)
// You can also set state with data
// controller.setData(list, STATE_SUCCESS)
}
private fun handleError() {
controller.setData(null)
// You can also set state with data
// controller.setData(null, STATE_ERROR)
}
private fun handleEmpty() {
controller.setData(emptyList())
// You can also set state with data
// controller.setData(null, STATE_EMPTY)
}
}The sample for this library uses Swapi SDK Revived for quick & custom implementation of lists