AndroidPluginVersion

class AndroidPluginVersion : Comparable

Represents a version of the Android Gradle Plugin

Designed for plugin authors to compare the currently running plugin version, so implements comparable.

For example AndroidPluginVersion(7, 0) refers to Android Gradle Plugin version 7.0.0, and AndroidPluginVersion(7, 0, 1) refers to Android Gradle Plugin version 7.0.1.

The internal representation is normalized, so that AndroidPluginVersion(7, 0) equals AndroidPluginVersion(7, 0, 0)

Also supports preview versions through methods alpha, beta and rc that return the more specific version. For example AndroidPluginVersion(7, 0).alpha(5) refers to Android Gradle Plugin version 7.0.0-alpha05. This is for use when developing using incubating APIs that have changed between preview releases of the Android Gradle Plugin. Once those APIs are stable in a stable version of Android Gradle Plugin, it's recommended to drop support for the preview versions. For example, if a new API was introduced in 7.0.0-alpha05, you can test for that using

``if (androidComponents.pluginVersion >= AndroidPluginVersion(7, 0).alpha(5)) { ... }``

If that API is marked as stable in 7.0.0, drop support for the preview versions before it by updating your condition to:

``if (androidComponents.pluginVersion >= AndroidPluginVersion(7, 0)) { ... }``

Take care with maximum version checks to avoid excluding point releases. For example, if a behavior is only applicable for AGP 8.7 series, and you have a different code path for the following version, don't check for 8.7.0 as the maximum, as your plugin will break on point releases of 8.7.0, instead compare with an exclusive bound with the first alpha of the subsequent major-minor version. (This applies even if the alpha is never released as it turned out to be a major version)

``if (androidComponents.pluginVersion < AndroidPluginVersion(8, 8).alpha(1)) { ... }``

Summary

fun getCurrent(): AndroidPluginVersion

AndroidPluginVersion(major: Int, minor: Int)

AndroidPluginVersion(major: Int, minor: Int, micro: Int)

fun alpha(alpha: Int): AndroidPluginVersion

fun beta(beta: Int): AndroidPluginVersion

open operator fun compareTo(other: AndroidPluginVersion): Int

fun dev(): AndroidPluginVersion

open operator fun equals(other: Any?): Boolean

open fun hashCode(): Int

fun rc(rc: Int): AndroidPluginVersion

open fun toString(): String

val major: Int

val micro: Int

val minor: Int

val preview: Int

val previewType: String?

val version: String