Inspectopedia Help

Non-final '@GuardedBy' field

Reports @GuardedBy annotations in which the guarding field is not final.

Guarding on a non-final field may result in unexpected race conditions, as locks will be held on the value of the field (which may change), rather than the field itself.

Example:

private ReadWriteLock lock = new ReentrantReadWriteLock(); //not final guarding field private Object state; @GuardedBy("lock") public void bar() { state = new Object(); }

Supported @GuardedBy annotations are:

  • net.jcip.annotations.GuardedBy

  • javax.annotation.concurrent.GuardedBy

  • org.apache.http.annotation.GuardedBy

  • com.android.annotations.concurrency.GuardedBy

  • androidx.annotation.GuardedBy

  • com.google.errorprone.annotations.concurrent.GuardedBy

Inspection Details

By default bundled with:

IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,

Can be installed with plugin:

Java, 241.16690

Last modified: 29 April 2024