Inspectopedia Help

Boolean method name must start with question word

Reports boolean methods whose names do not start with a question word.

Boolean methods that override library methods are ignored by this inspection.

Example:

boolean empty(List<String> list) { return list.isEmpty(); }

A quick-fix that renames such methods is available only in the editor.

Configure the inspection:

  • Use the Boolean method name prefixes list to specify acceptable question words to start boolean method names with.

  • Use the Ignore methods with 'java.lang.Boolean' return type option to ignore methods with the java.lang.Boolean return type.

  • Use the Ignore boolean methods in an @interface option to ignore boolean methods in annotation types (@interface).

  • Use the Ignore methods overriding/implementing a super method to ignore methods the have supers.

Inspection options

Option

Type

Default

Boolean method name prefixes

StringList

[are, can, check, contains, could, endsWith, equals, has, is, matches, must, shall, should, startsWith, was, were, will, would]

Ignore methods with 'java.lang.Boolean' return type

Checkbox

false

Ignore methods overriding/implementing a super method

Checkbox

true

Ignore boolean methods in an @interface

Checkbox

true

Inspection Details

Available in:

IntelliJ IDEA 2023.3, Qodana for JVM 2023.3

Plugin:

Java, 233.SNAPSHOT

Last modified: 13 July 2023