Skip to main content

How to avoid API-level warning of Android Studio

Before giving the solution, let's start with a scenario.

setSelectionFromTop() is a new method in Android Lollipop API. This method is basically beneficial to precisely keep scroll state of a ListView. By keeping that info, a developer can go back to old scroll state after doing some operation like data set change.

You are aware of API level and you do your control before you call this function:

if (currentapiVersion >= Build.VERSION_CODES.LOLLIPOP) {
    srlistview.setSelectionFromTop(index, top);
}
But if project minSdk is set to a lower level (in this case it is 15), this warning will still be displayed in Android Studio:

Call requires API level 21 (current min is 15): android.widget.AbsListView#setSelectionFromTop less... (Ctrl+F1) 

This check scans through all the Android API calls in the application and warns about any calls that are not available 
on all versions targeted by this application (according to its minimum SDK attribute in the manifest).  

If you really want to use this API and don't need to support older devices just set the minSdkVersion in your build.gradle or 
AndroidManifest.xml files. If your code is deliberately accessing newer APIs, and you have ensured  (e.g. with conditional execution) 
that this code will only ever be called on a supported platform, then you can annotate
your class or method with the @TargetApi annotation specifying the local minimum SDK to apply, such as @TargetApi(11),
such that this check considers 11 rather than your manifest file's minimum SDK as the required API level.  

If you are deliberately setting android: attributes in style definitions, make sure you place this in a values-vNN folder in order 
to avoid running into runtime conflicts on certain devices where manufacturers have added custom attributes whose ids 
conflict with the new ones on later platforms.  

Similarly, you can use tools:targetApi="11" in an XML file to indicate that the element will only be inflated in an adequate context.

To this warning, the IDE will automatically recommend some solutions and the first one will be to put @TargetApi annotation above your method definition. But the issue is not related to whole function but only one line. Additionally, it is under your control to call it with an if clause.

So, how to get rid of this warning? Simply override this method and place a annotation to show target api for this method:

@TargetApi(Build.VERSION_CODES.LOLLIPOP)
@Override
public void setSelectionFromTop(int position, int y) {
    super.setSelectionFromTop(position, y);
}
Now you can see that this warning has disappeared. This is a quick way for just a single method. Depending on various cases, more handy ways are available. For example, you can write a class which directly addresses to specific API level.

Anyway. In any case, it is not a compile error. So, we can just compile and continue our way. Happy coding! ;)

Comments

Post a Comment