oshi.annotation.concurrent.GuardedBy Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2020-2022 The OSHI Project Contributors
* SPDX-License-Identifier: MIT
*/
package oshi.annotation.concurrent;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The field or method to which this annotation is applied can only be accessed when holding a particular lock, which
* may be a built-in (synchronization) lock, or may be an explicit {@code java.util.concurrent.Lock}.
*
* The argument determines which lock guards the annotated field or method:
*
* - {@code this} : The string literal "this" means that this field is guarded by the class in which it is defined.
*
- {@code class-name.this} : For inner classes, it may be necessary to disambiguate 'this'; the class-name.this
* designation allows you to specify which 'this' reference is intended
*
- {@code itself} : For reference fields only; the object to which the field refers.
*
- {@code field-name} : The lock object is referenced by the (instance or static) field specified by field-name.
*
- {@code class-name.field-name} : The lock object is reference by the static field specified by
* class-name.field-name.
*
- {@code method-name()} : The lock object is returned by calling the named nil-ary method.
*
- {@code class-name.class} : The Class object for the specified class should be used as the lock object.
*
*
* This annotation is intended for internal use in OSHI as a temporary workaround until it is available in
* {@code jakarta.annotations}.
*/
@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.CLASS)
public @interface GuardedBy {
String value();
}