oshi.annotation.concurrent.GuardedBy Maven / Gradle / Ivy
/**
* MIT License
*
* Copyright (c) 2010 - 2020 The OSHI Project Contributors: https://github.com/oshi/oshi/graphs/contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
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();
}