GuardedBy

Artifact: androidx.annotation:annotation

View Source

Added in 1.0.0

---

Kotlin |Java

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])
@Retention(value = AnnotationRetention.BINARY)
public annotation GuardedBy

---

Denotes that the annotated method or field can only be accessed when holding the referenced lock.

Example:

final Object objectLock = new Object();

@GuardedBy("objectLock")
volatile Object object;

Object getObject() {
    synchronized (objectLock) {
        if (object == null) {
            object = new Object();
        }
    }
    return object;
}

Summary

Public constructors
GuardedBy(@NonNull String value)

Public methods
final @NonNull String	getValue()

Public constructors

GuardedBy

public GuardedBy(@NonNull String value)

Public methods

getValue

public final @NonNull String getValue()