ReplacedByIncubating
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.FIELD, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])
@Retention(value = AnnotationRetention.RUNTIME)
annotation ReplacedByIncubating
Annotation for APIs that are in the process of being replaced by an org.gradle.api.Incubating API.
When replacing a stable method with a new API which is org.gradle.api.Incubating, we cannot directly deprecate the old method as it would leave the user to use either between a deprecated or an incubating API.
Therefore, when replacing a public API with a new version, the following rules apply :
-
The new API will be annotated with
org.gradle.api.Incubating -
The old API will be annotated with
ReplacedByIncubatingbut will not be deprecated yet. -
Once the new API becomes stable, the old API
ReplacedByIncubatingwill be replaced with aDeprecatedannotation. -
After the deprecation period has passed, the old API will be removed.
Users can use this annotation presence to start moving their code to the new API if they do not object using an incubating potentially unstable API.
This interface is meant to document the Android Gradle Plugin APIs and should not be used by third party plugins/build logic.
Summary
Public constructors |
|---|
ReplacedByIncubating(message: String, bugId: Long) |