Skip to main content

Empty-blocks Rule Set

The empty-blocks ruleset contains rules that will report empty blocks of code which should be avoided.

EmptyCatchBlock​

Reports empty catch blocks. Empty catch blocks indicate that an exception is ignored and not handled. In case exceptions are ignored intentionally, this should be made explicit by using the specified names in the allowedExceptionNameRegex.

Active by default: Yes - Since v1.0.0

Debt: 5min

Configuration options:​

  • allowedExceptionNameRegex (default: '_|(ignore|expected).*')

    ignores exception types which match this regex

EmptyClassBlock​

Reports empty classes. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyDefaultConstructor​

Reports empty default constructors. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyDoWhileBlock​

Reports empty do/while loops. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyElseBlock​

Reports empty else blocks. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyFinallyBlock​

Reports empty finally blocks. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyForBlock​

Reports empty for loops. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyFunctionBlock​

Reports empty functions. Empty blocks of code serve no purpose and should be removed. This rule will not report functions with the override modifier that have a comment as their only body contents (e.g., a // no-op comment in an unused listener function).

Set the [ignoreOverridden] parameter to true to exclude all functions which are overriding other functions from the superclass or from an interface (i.e., functions declared with the override modifier).

Active by default: Yes - Since v1.0.0

Debt: 5min

Configuration options:​

  • ignoreOverriddenFunctions (default: false)

    Deprecated: Use ignoreOverridden instead

    Excludes all the overridden functions

  • ignoreOverridden (default: false)

    Excludes all the overridden functions

EmptyIfBlock​

Reports empty if blocks. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyInitBlock​

Reports empty init expressions. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyKtFile​

Reports empty Kotlin (.kt) files. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptySecondaryConstructor​

Reports empty secondary constructors. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyTryBlock​

Reports empty try blocks. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.6.0

Debt: 5min

EmptyWhenBlock​

Reports empty when expressions. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min

EmptyWhileBlock​

Reports empty while expressions. Empty blocks of code serve no purpose and should be removed.

Active by default: Yes - Since v1.0.0

Debt: 5min