https://github.com/mrmike/diffutil-sample

Android sample app in Kotlin showing usage of DiffUtil class.
https://github.com/mrmike/diffutil-sample

android android-sample android-support demo diffutil diffutil-sample kotlin

Last synced: 12 days ago
JSON representation

Android sample app in Kotlin showing usage of DiffUtil class.

• Host: GitHub
• URL: https://github.com/mrmike/diffutil-sample
• Owner: mrmike
• License: apache-2.0
• Created: 2016-08-18T18:01:33.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-10-01T05:58:46.000Z (about 4 years ago)
• Last Synced: 2024-12-10T02:11:00.901Z (21 days ago)
• Topics: android, android-sample, android-support, demo, diffutil, diffutil-sample, kotlin
• Language: Kotlin
• Homepage:
• Size: 2.35 MB
• Stars: 210
• Watchers: 9
• Forks: 41
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DiffUtil Android Sample - Kotlin

Example of usage [DiffUtil](https://developer.android.com/reference/android/support/v7/util/DiffUtil.html) utility class added originally in Support Library 24.2.0.

## Demo

![Demo](https://github.com/mrmike/DiffUtil-sample/blob/master/raw/diffutil-sample-320.gif?raw=true)

## Implementation

[*calculateDiff*](https://developer.android.com/reference/android/support/v7/util/DiffUtil.html#calculateDiff(android.support.v7.util.DiffUtil.Callback)) method from DiffUtill class requires [DiffUtil.Callback](https://developer.android.com/reference/android/support/v7/util/DiffUtil.Callback.html) object as parameter.

### DiffUtil callback - [ActorDiffCallback.kt](https://github.com/mrmike/DiffUtil-sample/blob/master/app/src/main/java/com/moczul/diffutilsample/ActorDiffCallback.kt)

Implements 4 methods:

* **getOldListSize** - returns size of the old list

* **getNewListSize** - returns size of the new list

* **areItemsTheSame** - returns true if two items are the same, e.g. have the same ids 

* **areContentsTheSame** - returns true if displayed content was not changed. In our case we only display actor's name so we're detecing name's change.

### Applying diff result - [ActorAdapter.swap()](https://github.com/mrmike/DiffUtil-sample/blob/master/app/src/main/java/com/moczul/diffutilsample/ActorAdapter.kt#L31)

DiffResult can be applied to adapter by calling **`diffResult.dispatchUpdatesTo(adapter)`**.

```

    fun swap(actors: List) {

            val diffCallback = ActorDiffCallback(this.actors, actors)

            val diffResult = DiffUtil.calculateDiff(diffCallback)

            this.actors.clear()

            this.actors.addAll(actors)

            diffResult.dispatchUpdatesTo(this)

    }

```

## Resources

* [DiffUtil @ developer.android.com](https://developer.android.com/reference/android/support/v7/util/DiffUtil.html)

* ["DiffUtil is a must!" @ Medium](https://medium.com/@nullthemall/diffutil-is-a-must-797502bc1149#.sejum95wh)

* ["Diffing Larger Changes" @ Codepath](http://guides.codepath.com/android/using-the-recyclerview#diffing-larger-changes)

## License

    Copyright 2016 Michał Moczulski

    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.