Add @DeprecatedSdkVersion annotation for indicating a method is deprecated after a certain minimum API level [37116481]

Fixed

Feature Request

Migrated-Tools-Lint

Status Update

No update yet.

Description

ja...@gmail.com

created issue #1

Aug 18, 2016 03:42PM

The support libraries and a few third party libraries provide compatibility methods for operation on older APIs where shims or backport implementations must be used. The problem is that there's no way to inform the user of when they no longer need to be using these methods.

I propose adding a new annotation to support-annotations like @DeprecatedSdkVersion whose value property is an SDK_INT but also provides an optional details property for what method to use instead.

public @Interface DeprecatedSdkVersion {
int value();
String details = "";
}

Which can be used like this:

public final class ViewCompat {
@DeprecatedSdkVersion(Build.VERSION_CODES.LOLLIPOP)
public static int getElevation(View view) { ... }

@DeprecatedSdkVersion(
value = Build.VERSION_CODES.LOLLIPOP,
details = "Use view.getElevation() directly."
)
public static int getElevation(View view) { ... }
}

(Other potential names: @MaxSdkVersion, @UntilSdkVersion)

This would come with a corresponding lint check that would issue a warning if you were using one of these methods with a minSdkVersion higher than the annotation's value.

Comments

ja...@gmail.com <ja...@gmail.com> #2Aug 18, 2016 05:21PM

we've considered this, just didn't have time to implement.

Btw, we cannot just use name() because it might be proguarded away. so we need to generate the code that matches enums to hardcoded string values.

If you are using name(), be careful about migrations since 2 different compilations might have different names for the enum values.

vs...@google.com <vs...@google.com> Aug 18, 2016 05:24PM

Assigned to tn...@google.com.

ja...@gmail.com <ja...@gmail.com> #3Sep 14, 2017 05:35PM

True. Even though this could be fixed by using proguard rules.

Would be great to see this in the future, it's really lots of code here ;)

so...@gmail.com <so...@gmail.com> #4Oct 4, 2017 09:43PM

What about the idea of using a more generic adapter which can handle all of the enums in your app? That way you could decide to persist them all with one "stone". You could choose to save them as strings, ordinals or even some other way of your choosing. But you would not have to add an adapter for every enum type in your app. You just have to add the one special enum adapter and Room would know how to use it for all enums.

ja...@gmail.com <ja...@gmail.com> #5Oct 4, 2017 10:06PM

This seems like a possible candidate for external contributions so moving it to the bug bounty hotlist.

We still need a proper design here hence not super straightforward.

Such design should ensure we are:

safe for proguard (in case we go w/ name)
have some logic for defaults (in case an enum is removed or renamed)
possibly support ordinals (though that might be a case where we can require a type converter)
possibly make it opt-in so that developer explicitly picks an option (e.g. some annotation on the enum to enable this)

tn...@google.com <tn...@google.com> #6Jan 21, 2022 06:14PM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-master-dev

commit ae093dec7bfdc578cf0d7cd2ee6c8563ddd4f5ed
Author: Elif Bilgin <elifbilgin@google.com>
Date: Wed Oct 21 11:50:07 2020

Optimization for storing enums in databases.

Creating a default type adapter to persist Enums in Room. Changes made in logic of the findQueryParameterAdapter(...) function where we now try to find a TypeConverter for the collection of an object first, and if not, then try to find one for the type arg.

Test: Baseline tests replicate compiler errors in EnumColumnTypeAdapterTest.java
Bug: 73132006
Change-Id: Ia212097c16fde4302bc7c20cbad1604a996090ad

M room/compiler-processing/src/main/java/androidx/room/compiler/processing/XType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/javac/JavacType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/ksp/KspArrayType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/ksp/KspDeclaredType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/ksp/KspType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/ksp/KspTypeArgumentType.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
A room/compiler/src/main/kotlin/androidx/room/solver/types/EnumColumnTypeAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/DaoProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/solver/TypeAdapterStoreTest.kt
A room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/EnumColumnTypeAdapterTest.java

https://android-review.googlesource.com/1469447

de...@google.com <de...@google.com> #7Feb 10, 2022 10:54PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit ed8d4acdb13cba24fcb1a392b36952ddfe790776
Author: Elif Bilgin <elifbilgin@google.com>
Date: Wed Oct 21 11:50:07 2020

Optimization for storing enums in databases.

Creating a default type adapter to persist Enums in Room. Changes made in logic of the findQueryParameterAdapter(...) function where we now try to find a TypeConverter for the collection of an object first, and if not, then try to find one for the type arg.

Test: Baseline tests replicate compiler errors in EnumColumnTypeAdapterTest.java
Bug: 73132006
Change-Id: I4cfa8c7f9ac3dc97ec4591ceef6f97b4cba7a6ad

M room/compiler-processing/src/main/java/androidx/room/compiler/processing/XType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/javac/JavacType.kt
M room/compiler-processing/src/main/java/androidx/room/compiler/processing/ksp/KspType.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
A room/compiler/src/main/kotlin/androidx/room/solver/types/EnumColumnTypeAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/DaoProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/solver/TypeAdapterStoreTest.kt
A room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/EnumColumnTypeAdapterTest.java

https://android-review.googlesource.com/1500819