org.bson.util.annotations.GuardedBy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson

There is a newer version: 3.1.0

/*
 * Copyright (c) 2005 Brian Goetz and Tim Peierls
 * Released under the Creative Commons Attribution License
 *   (http://creativecommons.org/licenses/by/2.5)
 * Official home: http://www.jcip.net
 *
 * Any republication or derived work distributed in source code form
 * must include this copyright and license notice.
 */

package org.bson.util.annotations;

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 java.util.concurrent.Lock.
 *
 * The argument determines which lock guards the annotated field or method:
 * 
 *      {@code this} : The intrinsic lock of the object in whose class the field 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. 
 * 
 *
 * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
 */
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Deprecated
public @interface GuardedBy {
    String value();
}