Use Java8 APIs on Older Android Versions

The less adoption of Java8 APIs in the Android Codebase is because of the lack of support on the older versions. Even though Java8 was released in 2014, it took a while for Google to resolve the issue.

Existing Issue

We will take an example to understand the issue in detail. Let's say we have an array list that contains countries and we need to check if the desired country is available in the list.

The code to achieve it would look something like below.

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
    // Find the country with name India
    val country = countryArrayList.stream().filter { it == "India" }.findFirst()
    if (country.isPresent) {
        // Country is present in the list
    } else {
        // Country is not present in the list
    }
} else {
    // For loop to filter and find the item on the older version
    var countryPresent = false
    countryArrayList.forEach {
        if (it == "India") {
            // Country is present in the list
            // Update the boolean value
            countryPresent = true
        }
    }
    if (countryPresent) {
        // Country is present in the list
    } else {
        // Country is not present in the list
    }
}

The above code is huge. What we are essentially doing was that we are using Java8 Stream APIs to filter and check whether the desired country exists or not on Android versions above 24 (Android N) and on the older version, we are using simple for loop with a boolean for a similar outcome.

If we don't write version-specific logic when using Java8 APIs, we would be shown a warning by Android Studio. The builds won't fail but the app will crash in the older versions.

java-8-api-error

Because of this lack of official support till now, we had to rely on multiple third-party libraries to avoid writing version specific logic.

Solution

To enable the official support in Android Studio, first thing to make sure is that we are using Android Studio version greater than 4.0.0.

Incase, we have set out minSdkVersion to less than 20, we need to add Multi Dex Support, otherwise this would be enabled by default.

Next, enable desugaring by adding coreLibraryDesugaringEnabled flag in compileOptions.

compileOptions {
    // Additional Java 8 APIs (Streams, Java Time) Support
    coreLibraryDesugaringEnabled true
    // Existing Java 8 (Lambda Expressions) Support
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
    jvmTarget = '1.8'
}
Finally, add the following dependency to the dependency block in the module level build.gradle file. 
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.0.9'
Once added, the errors and crashes with code below would be resolved. This makes version specific logic, like we have mentioned in the early part of the article redundant.
val country = countryArrayList.stream().filter { it == "India" }.findFirst()
if (country.isPresent) {
    // Country is present in the list
} else {
    // Country is not present in the list
}

The findFirst method returns Optional.empty if the country specified in the filter is not present in the list. Otherwise, it will return the item as an option, Optional[India].

There are other ways we can find whether the item is present or not and how many times it got repeated but this is the way we have explored in the article.

What is Happening

On older versions, the library is simply compiling missing APIs to a separate dex file and is adding it to the APK. In addition to that, the library also rewrites our app's code to use this library instead during the runtime.

We have only discussed support for one API. For a detailed list of supported Java8 APIs, take a look at the Developer website.

Let's hope in the future releases of Android Studio, this Desugaring is added automatically and we don't have to add it manually.

Popular posts from this blog

Create Assets Folder, Add Files and Read Data From It

Image
Sometimes, we need to read the data stored in the files during runtime and want to make sure the data is not tampered by the Android build system. In this article, we will take a look at how to create the assets folder using Android Studio and read the stored data from it. First, Right-click on the module name or the package name. This opens an option window where we need to select the Assets Folder option by hovering over New and then on the Folder option. Now, we will see a window where we change the folder location and the source set. Change the values if necessary otherwise keep the defaults and click Finish. It may trigger a Gradle Sync. Irrespective of the sync, the Assets folder is created and is visible in the module. Now, Right-click on the Assets folder and click on the File option by hovering over the New option. Enter the name of the file name and click Enter to create the file. The file with the name user_details.json is created under the assets folder. Add some JSON...
Read more

How to Read Metadata from AndriodManifest File

Metadata tags are key-value pairs and one of the decent ways to access the API keys from the libraries. They are added to the AndroidManifest.xml under the application tag and are available through the PackageManager . If you have worked with third-party libraries or even with App shortcuts, Downloadable Fonts, Firebase MLKit, you may have come across metadata tags. In the article, let’s add the metadata tags to the app module’s Manifest file and read the metadata key-values and the key-resource from a library module both in kotlin and java. Add meta-data: Add metadata to the app module's AndroidManifest.xml file under the application tag. You can add as many metadata elements as you want and you can also add metadata under the activity, service, broadcast receiver, content provider tags. <meta-data android:name= "com.gsrikar.library.LIBRARY_ACCESS_KEY" android:value= "masndfiu4er9funwikesd" /> <meta-data and...
Read more

Add Spacing to Recycler View Linear Layout Manager Using Item Decoration

Image
In this article we will learn about, item decoration in Android and how we can use it to add even spacing between the child items. A RecyclerView without spacing will look like the image below but in most cases, we want to add spacing between the items. [You can see there are no margins between the views and only elevation] A more traditional option is adding margins in the list item xml file. If we take this route, we will soon end up with uneven spacing issues with vertical margins. [There are even left, right, top, bottom margins for all the rows except the last item in the first image and in the subsequent image, the top margin for the first item is half of the other items] The best way is to add the ItemDecoration to the RecyclerView as it affects the individual items and you can have more control over them. Kotlin: /** * Add vertical, horizontal spacing to the recycler view */ class DefaultItemDecorator(private val horizontalSpacing: Int, ...
Read more

Run the Emulator directly in Android Studio

Image
In Android Studio 4.1, a minor feature is released to reduce the screen (or window) switching between Android Studio and the Emulator. Using this feature, we can now run the Emulator directly inside the Android Studio. We can make the changes to the code and see the changes reflect in the emulator in the same window similar to layout XML and its preview. To achieve this, open the Preferences window and select the Emulator menu item under the Tools expandable menu. Here we can check the option Launch in a tool window and click OK . Now run the Emulator to see it inside the Android Studio window.
Read more

How to Change Material Chip Text Size, Text Style and Font

Chips in Android is a Material Design Component used primarily for actions or choice or during filters or as an input. The attributes like textColor , textStyle and fontFamily are ignored when added to the Material Chips directly. We need to modify these values using textAppearance . <com.google.android.material.chip.Chip android:id="@+id/maleChip" style="@style/Widget.MaterialComponents.Chip.Choice" android:layout_width="wrap_content" android:layout_height="wrap_content" android:checkable="true" android:layoutDirection="locale" android:text="@string/chip_text_male" android:textAppearance="@style/AppTheme.GenderChip" android:textColor="@color/colorWhiteText" app:chipBackgroundColor="@drawable/select_chip" app:chipEndPadding="@dimen/chip_horizontal_margin" app:chipStartPadding="@dimen/chip_horizontal_margin...
Read more