Inspectopedia Help

Unstable type is used in signature

Reports declarations of classes, methods, and fields that reference an unstable API type in the signature, but are not marked with the same unstable annotation.

This inspection ensures that the signatures of a public API do not expose any unstable (internal, experimental) types. For example, if a method returns an experimental class, the method itself is considered experimental because incompatible changes of the type (deletion or move to another package) lead to incompatible method signature changes.

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

UnstableTypeUsedInSignature
Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | JVM languages

Use the list below to specify which annotations mark an unstable API.

Inspection options

Here you can find the description of settings available for the Unstable type is used in signature inspection, and the reference of their default values.

Unstable API annotations

[org.jetbrains.annotations.ApiStatus.ScheduledForRemoval, org.jetbrains.annotations.ApiStatus.Experimental, org.jetbrains.annotations.ApiStatus.Internal, com.google.common.annotations.Beta, io.reactivex.annotations.Beta, io.reactivex.annotations.Experimental, rx.annotations.Experimental, rx.annotations.Beta, org.apache.http.annotation.Beta, org.gradle.api.Incubating]

Availability

By default bundled with

IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,

Can be installed with plugin

Java, 241.18072

Last modified: 18 June 2024