AlertDialogUsage.md.html

<meta charset="utf-8">
(#) Use the support library AlertDialog instead of android.app.AlertDialog

!!! WARNING: Use the support library AlertDialog instead of android.app.AlertDialog
   This is a warning.

Id
:   `AlertDialogUsage`
Summary
:   Use the support library AlertDialog instead of android.app.AlertDialog
Severity
:   Warning
Category
:   Correctness
Platform
:   Any
Vendor
:   vanniktech/lint-rules/
Feedback
:   https://github.com/vanniktech/lint-rules/issues
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.0 and 8.1
Artifact
:   [com.vanniktech:lint-rules-android](com_vanniktech_lint-rules-android.md.html)
Since
:   0.9.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/main/kotlin/com/vanniktech/lintrules/android/AlertDialogUsageDetector.kt)
Tests
:   [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/AlertDialogUsageDetectorTest.kt)

Support library AlertDialog is much more powerful and plays better
together with the new theming / styling than the AlertDialog built into
the framework.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/Test.java:4:Warning: Should not be using android.app.AlertDialog
[AlertDialogUsage]
  public Test(AlertDialog dialog) { }
              ------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/Test.java`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~java linenumbers
import android.app.AlertDialog;

class Test {
  public Test(AlertDialog dialog) { }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/AlertDialogUsageDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `AlertDialogUsageDetector.constructorParameterInJava`.
To report a problem with this extracted sample, visit
https://github.com/vanniktech/lint-rules/issues.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project. This lint check is included in the lint documentation,
   but the Android team may or may not agree with its recommendations.

```
// build.gradle.kts
lintChecks("com.vanniktech:lint-rules-android:0.25.0")

// build.gradle
lintChecks 'com.vanniktech:lint-rules-android:0.25.0'

// build.gradle.kts with version catalogs:
lintChecks(libs.lint.rules.android)

# libs.versions.toml
[versions]
lint-rules-android = "0.25.0"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
lint-rules-android = {
    module = "com.vanniktech:lint-rules-android",
    version.ref = "lint-rules-android"
}
```

0.25.0 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about com.vanniktech:lint-rules-android](com_vanniktech_lint-rules-android.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("AlertDialogUsage")
  fun method() {
     problematicStatement()
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("AlertDialogUsage")
  void method() {
     problematicStatement();
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection AlertDialogUsage
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="AlertDialogUsage" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'AlertDialogUsage'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore AlertDialogUsage ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>