Exhaustiveness check for switch expressions

Reports switch expressions that do not cover all possible outcomes of the matched expression.

Groovy does not require that switch expression must be exhaustive. It acts as if an implicit default -> null branch is inserted. It may cause unexpected nulls if a developer forgets to insert necessary case branches.

Example:

  enum A { X, Y }

  def foo(A a) {
    def x = switch (a) { // reports switch
      case A.X -> ...
    }
  }

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.

GrSwitchExhaustivenessCheck

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 | Groovy | Probable bugs

Inspection options

Here you can find the description of settings available for the Exhaustiveness check for switch expressions inspection, and the reference of their default values.

Report unmatched 'null': Not selected

Availability

By default bundled with: IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,
Can be installed with plugin: Groovy, 241.18072

Last modified: 18 June 2024